2 lines
11 KiB
JavaScript
2 lines
11 KiB
JavaScript
import{_ as e,c as r,o as t,a}from"./app.54944ef9.js";const g='{"title":"Differences from VuePress","description":"","frontmatter":{"sidebarDepth":2},"headers":[{"level":2,"title":"General","slug":"general"},{"level":2,"title":"Markdown","slug":"markdown"},{"level":2,"title":"Site Config","slug":"site-config"},{"level":2,"title":"Default Theme Config","slug":"default-theme-config"},{"level":2,"title":"Default Theme","slug":"default-theme"},{"level":2,"title":"Computed Globals","slug":"computed-globals"},{"level":2,"title":"Frontmatter Predefined Variables","slug":"frontmatter-predefined-variables"},{"level":2,"title":"Frontmatter Default Theme Variables","slug":"frontmatter-default-theme-variables"},{"level":2,"title":"siteData","slug":"sitedata"},{"level":2,"title":"pageData","slug":"pagedata"},{"level":2,"title":"Global Components","slug":"global-components"}],"relativePath":"guide/differences-from-vuepress.md","lastUpdated":1652768268000}',o={},l=a('<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>',27),s=[l];function i(n,d,c,u,h,p){return t(),r("div",null,s)}var m=e(o,[["render",i]]);export{g as __pageData,m as default};
|