24 lines
20 KiB
HTML
24 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Differences from VuePress | VitePress</title>
|
|
<meta name="description" content="Vite & Vue powered static site generator.">
|
|
<link rel="stylesheet" href="/assets/style.82fdbeb8.css">
|
|
<link rel="modulepreload" href="/assets/chunks/ui-custom.1a068566.js">
|
|
<link rel="modulepreload" href="/assets/chunks/ui-custom.30ce3a39.js">
|
|
<link rel="modulepreload" href="/assets/chunks/AlgoliaSearchBox.e5144af4.js">
|
|
<link rel="modulepreload" href="/assets/app.54944ef9.js">
|
|
<link rel="modulepreload" href="/assets/guide_differences-from-vuepress.md.459a9c4a.lean.js">
|
|
|
|
<meta name="twitter:title" content="Differences from VuePress | VitePress">
|
|
<meta property="og:title" content="Differences from VuePress | VitePress">
|
|
</head>
|
|
<body>
|
|
<div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-675d8756><div class="sidebar-button" data-v-675d8756><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/" aria-label="VitePress, back to home" data-v-675d8756 data-v-cc01ef16><!----> VitePress</a><div class="flex-grow" data-v-675d8756></div><div class="nav" data-v-675d8756><nav class="nav-links" data-v-675d8756 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item active" href="/" data-v-b8818f8c>Guide <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/config/basics" data-v-b8818f8c>Config Reference <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/vuejs/vitepress/releases" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>Release Notes <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/vuejs/vitepress" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--[--><div class="algolia-search-box" id="docsearch"></div><!--]--><!--]--></header><aside class="sidebar" data-v-83e92a68><nav class="nav-links nav" data-v-83e92a68 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item active" href="/" data-v-b8818f8c>Guide <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/config/basics" data-v-b8818f8c>Config Reference <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/vuejs/vitepress/releases" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>Release Notes <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/vuejs/vitepress" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-83e92a68><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/">What is VitePress?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/getting-started">Getting Started</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/configuration">Configuration</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/assets">Asset Handling</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/markdown">Markdown Extensions</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/using-vue">Using Vue in Markdown</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/deploy">Deploying</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Advanced</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/frontmatter">Frontmatter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/theming">Theming</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/guide/api">API Reference</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/guide/differences-from-vuepress">Differences from Vuepress</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-7eddb2c4><div class="container" data-v-7eddb2c4><!--[--><!--[--><div id="ads-container"><div class="carbon-ads" data-v-5941b830></div></div><!--]--><!--[--><!--]--><!--]--><div style="position:relative;" class="content" data-v-7eddb2c4><div><h1 id="differences-from-vuepress" tabindex="-1">Differences from VuePress <a class="header-anchor" href="#differences-from-vuepress" aria-hidden="true">#</a></h1><p>VitePress and VuePress have different <a href="./../">design goals</a>. Both projects share similar config naming conventions. VitePress aims to have the bare minimum features needed for authoring docs. Other features are pushed to Themes. On the other hand, VuePress has more features out-of-the-box or enabled by its ecosystem of plugins.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you are using VuePress, there is no need to migrate to VitePress. Both projects are going to continue to co-exist for the foreseeable future.</p></div><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Note this is early WIP! Currently, the focus is on making Vite stable and feature-complete first. It is not recommended to use this for anything serious yet.</p></div><p>In case you decide to move your project to VitePress, this is a list of differences from <a href="https://github.com/vuejs/vuepress/releases/tag/v1.7.1" target="_blank" rel="noopener noreferrer">VuePress v1.7.1</a> that you need to take into account.</p><h2 id="general" tabindex="-1">General <a class="header-anchor" href="#general" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li>YAML and TOML are not supported formats for site config. Only javascript is supported for <code>.vitepress/config.js</code></li><li><a href="https://vuepress.vuejs.org/plugin/" target="_blank" rel="noopener noreferrer">Plugins</a> support, features are implemented in themes</li><li><a href="https://vuepress.vuejs.org/guide/permalinks.html" target="_blank" rel="noopener noreferrer">permalink support</a></li><li><code>.vitepress/templates</code></li><li>Components in <code>.vitepress/components</code> <a href="https://vuepress.vuejs.org" target="_blank" rel="noopener noreferrer">are not auto registered as global components</a></li></ul></li><li>Differences <ul><li><a href="https://vuepress.vuejs.org/guide/assets.html#public-files" target="_blank" rel="noopener noreferrer">Public files</a> that are directly copied to dist root moved from <code>.vitepress/public/</code> is <code>public/</code></li><li><a href="https://vuepress.vuejs.org/config/#styling" target="_blank" rel="noopener noreferrer">styling</a> <code>.vitepress/styles/index.styl</code> and <code>.vitepress/styles/palette.styl</code> is not supported. See <a href="./theming.html#customizing-css">Customizing CSS</a>.</li><li><a href="https://vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements" target="_blank" rel="noopener noreferrer">App Level Enhancements</a> API, app enhancements <code>.vitepress/enhanceApp.js</code> is now done in <code>.vitepress/theme/index.js</code>. See <a href="./theming.html#extending-the-default-theme">Extending the Default Theme</a>.</li></ul></li></ul><h2 id="markdown" tabindex="-1">Markdown <a class="header-anchor" href="#markdown" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li>Support for <a href="https://vuepress.vuejs.org/guide/frontmatter.html#alternative-frontmatter-formats" target="_blank" rel="noopener noreferrer">toml in frontmatter</a></li><li><a href="https://vuepress.vuejs.org/guide/markdown.html#custom-containers" target="_blank" rel="noopener noreferrer">details block</a></li><li><a href="https://vuepress.vuejs.org/guide/markdown-slot.html" target="_blank" rel="noopener noreferrer">markdown slots</a></li><li><code>~</code> prefix to explicitly specify a url is a <a href="https://vuepress.vuejs.org/guide/assets.html#relative-urls" target="_blank" rel="noopener noreferrer">webpack module request</a></li></ul></li></ul><h2 id="site-config" tabindex="-1">Site Config <a class="header-anchor" href="#site-config" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><code>temp</code></li><li><code>dest</code></li><li><a href="https://vuepress.vuejs.org/theme/using-a-theme.html#using-a-theme-from-a-dependency" target="_blank" rel="noopener noreferrer"><code>theme</code> from a dependency</a></li><li><code>permalink</code></li><li><a href="https://vuepress.vuejs.org/config/#port" target="_blank" rel="noopener noreferrer"><code>port</code></a></li><li><a href="https://vuepress.vuejs.org/config/#shouldprefetch" target="_blank" rel="noopener noreferrer"><code>shouldPrefetch</code></a></li><li><a href="https://vuepress.vuejs.org/config/#cache" target="_blank" rel="noopener noreferrer"><code>cache</code></a></li><li><a href="https://vuepress.vuejs.org/config/#extrawatchfiles" target="_blank" rel="noopener noreferrer"><code>extraWatchFiles</code></a></li><li><a href="https://vuepress.vuejs.org/config/#patterns" target="_blank" rel="noopener noreferrer"><code>patterns</code></a></li><li><a href="https://vuepress.vuejs.org/config/#pluggable" target="_blank" rel="noopener noreferrer"><code>plugins</code></a></li><li><a href="https://vuepress.vuejs.org/config/#markdown-pagesuffix" target="_blank" rel="noopener noreferrer"><code>markdown.pageSuffix</code></a></li><li><a href="https://vuepress.vuejs.org/config/#markdown-slugify" target="_blank" rel="noopener noreferrer"><code>markdown.slugify</code></a></li><li><a href="https://vuepress.vuejs.org/config/#markdown-plugins" target="_blank" rel="noopener noreferrer"><code>markdown.plugins</code></a></li><li><a href="https://vuepress.vuejs.org/config/#markdown-extractheaders" target="_blank" rel="noopener noreferrer"><code>markdown.extractHeaders</code></a></li><li><code>markdown.extendMarkdown</code> to <code>markdown.config</code></li><li><code>configureWebpack</code>, <code>chainWebpack</code>, <code>postcss</code>, <code>Stylus</code>, <code>scss</code>, <code>Sass</code>, <code>less</code> configs</li><li><a href="https://vuepress.vuejs.org/config/#evergreen" target="_blank" rel="noopener noreferrer"><code>evergreen</code></a></li></ul></li></ul><h2 id="default-theme-config" tabindex="-1">Default Theme Config <a class="header-anchor" href="#default-theme-config" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#smooth-scrolling" target="_blank" rel="noopener noreferrer"><code>smoothScroll</code></a></li><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#displaying-header-links-of-all-pages" target="_blank" rel="noopener noreferrer"><code>displayAllHeaders</code></a></li><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#active-header-links" target="_blank" rel="noopener noreferrer"><code>activeHeaderLinks</code></a></li><li><code>sidebarDepth</code> and <code>initialOpenGroupIndex</code> for <a href="https://vuepress.vuejs.org/theme/default-theme-config.html#sidebar-groups" target="_blank" rel="noopener noreferrer">sidebar groups</a></li></ul></li><li>Differences <ul><li><code>searchMaxSuggestions</code> is <code>search.maxSuggestions</code></li><li><code>algolia</code> is <code>search.algolia</code></li><li><code>searchPlaceholder</code> is <code>search.placeholder</code></li></ul></li></ul><h2 id="default-theme" tabindex="-1">Default Theme <a class="header-anchor" href="#default-theme" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#code-groups-and-code-blocks" target="_blank" rel="noopener noreferrer"><code><code-group></code> and <code><code-block></code></a></li></ul></li></ul><h2 id="computed-globals" tabindex="-1">Computed Globals <a class="header-anchor" href="#computed-globals" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><code>$lang</code></li><li><code>$localePath</code></li></ul></li></ul><h2 id="frontmatter-predefined-variables" tabindex="-1">Frontmatter Predefined Variables <a class="header-anchor" href="#frontmatter-predefined-variables" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><code>description</code></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#meta" target="_blank" rel="noopener noreferrer"><code>meta</code></a></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables" target="_blank" rel="noopener noreferrer"><code>metaTitle</code></a></li><li><code>lang</code></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#layout" target="_blank" rel="noopener noreferrer"><code>layout</code></a></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables" target="_blank" rel="noopener noreferrer"><code>permalink</code></a></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables" target="_blank" rel="noopener noreferrer"><code>canonicalUrl</code></a></li></ul></li></ul><h2 id="frontmatter-default-theme-variables" tabindex="-1">Frontmatter Default Theme Variables <a class="header-anchor" href="#frontmatter-default-theme-variables" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><code>prev</code>, <code>next</code></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#search" target="_blank" rel="noopener noreferrer"><code>search</code></a></li><li><a href="https://vuepress.vuejs.org/guide/frontmatter.html#tags" target="_blank" rel="noopener noreferrer"><code>tags</code></a></li><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#custom-page-class" target="_blank" rel="noopener noreferrer"><code>pageClass</code></a></li><li><a href="https://vuepress.vuejs.org/theme/default-theme-config.html#custom-layout-for-specific-pages" target="_blank" rel="noopener noreferrer"><code>layout</code></a></li></ul></li></ul><h2 id="sitedata" tabindex="-1">siteData <a class="header-anchor" href="#sitedata" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><a href="https://vuepress.vuejs.org/theme/writing-a-theme.html#site-and-page-metadata" target="_blank" rel="noopener noreferrer"><code>pages</code></a></li></ul></li></ul><h2 id="pagedata" tabindex="-1">pageData <a class="header-anchor" href="#pagedata" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><code>key</code></li><li><code>path</code></li><li><code>regularPath</code></li></ul></li></ul><h2 id="global-components" tabindex="-1">Global Components <a class="header-anchor" href="#global-components" aria-hidden="true">#</a></h2><ul><li>Missing <ul><li><a href="https://vuepress.vuejs.org/guide/using-vue.html#badge" target="_blank" rel="noopener noreferrer"><code><Badge></code></a></li></ul></li></ul></div></div><footer class="page-footer" data-v-7eddb2c4 data-v-07c132fc><div class="edit" data-v-07c132fc><div class="edit-link" data-v-07c132fc data-v-1ed99556><a class="link" href="https://github.com/vuejs/vitepress/edit/main/docs/guide/differences-from-vuepress.md" target="_blank" rel="noopener noreferrer" data-v-1ed99556>Edit this page on GitHub <svg class="icon outbound icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-1ed99556><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="updated" data-v-07c132fc><p class="last-updated" data-v-07c132fc data-v-abce3432><span class="prefix" data-v-abce3432>Last Updated:</span><span class="datetime" data-v-abce3432></span></p></div></footer><div class="next-and-prev-link" data-v-7eddb2c4 data-v-38ede35f><div class="container" data-v-38ede35f><div class="prev" data-v-38ede35f><a class="link" href="/guide/api" data-v-38ede35f><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-38ede35f><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-38ede35f>API Reference</span></a></div><div class="next" data-v-38ede35f><!----></div></div></div><!--[--><!--[--><!--]--><!--[--><div class="buy-sell-ads" data-v-4ce5ad17><div class="bsa-cpc" data-v-4ce5ad17></div></div><!--]--><!--]--></div></main></div><!----><!--]--></div>
|
|
<script>__VP_HASH_MAP__ = JSON.parse("{\"config_algolia-search.md\":\"da33e9e2\",\"config_basics.md\":\"8b6d1758\",\"config_carbon-ads.md\":\"2699d04a\",\"config_homepage.md\":\"2f01ca2d\",\"guide_api.md\":\"03e88529\",\"guide_assets.md\":\"aae76804\",\"guide_configuration.md\":\"bb340dd8\",\"guide_deploy.md\":\"661eacb4\",\"guide_differences-from-vuepress.md\":\"459a9c4a\",\"guide_frontmatter.md\":\"07dc76f0\",\"guide_getting-started.md\":\"f9753073\",\"guide_global-component.md\":\"01405ea5\",\"guide_markdown.md\":\"6ff83e9e\",\"guide_theming.md\":\"b28ff51e\",\"guide_using-vue.md\":\"74e82a4f\",\"index.md\":\"9a001cbe\"}")</script>
|
|
<script type="module" async src="/assets/app.54944ef9.js"></script>
|
|
|
|
</body>
|
|
</html> |