Differences from VuePress
VitePress and VuePress have different design goals. 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.
TIP
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.
WARNING
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.
In case you decide to move your project to VitePress, this is a list of differences from VuePress v1.7.1 that you need to take into account.
General
- Missing
- YAML and TOML are not supported formats for site config. Only javascript is supported for
.vitepress/config.js - Plugins support, features are implemented in themes
- permalink support
.vitepress/templates- Components in
.vitepress/componentsare not auto registered as global components
- YAML and TOML are not supported formats for site config. Only javascript is supported for
- Differences
- Public files that are directly copied to dist root moved from
.vitepress/public/ispublic/ - styling
.vitepress/styles/index.styland.vitepress/styles/palette.stylis not supported. See Customizing CSS. - App Level Enhancements API, app enhancements
.vitepress/enhanceApp.jsis now done in.vitepress/theme/index.js. See Extending the Default Theme.
- Public files that are directly copied to dist root moved from
Markdown
- Missing
- Support for toml in frontmatter
- details block
- markdown slots
~prefix to explicitly specify a url is a webpack module request
Site Config
- Missing
tempdestthemefrom a dependencypermalinkportshouldPrefetchcacheextraWatchFilespatternspluginsmarkdown.pageSuffixmarkdown.slugifymarkdown.pluginsmarkdown.extractHeadersmarkdown.extendMarkdowntomarkdown.configconfigureWebpack,chainWebpack,postcss,Stylus,scss,Sass,lessconfigsevergreen
Default Theme Config
- Missing
smoothScrolldisplayAllHeadersactiveHeaderLinkssidebarDepthandinitialOpenGroupIndexfor sidebar groups
- Differences
searchMaxSuggestionsissearch.maxSuggestionsalgoliaissearch.algoliasearchPlaceholderissearch.placeholder
Default Theme
- Missing
Computed Globals
- Missing
$lang$localePath
Frontmatter Predefined Variables
- Missing
descriptionmetametaTitlelanglayoutpermalinkcanonicalUrl
Frontmatter Default Theme Variables
siteData
- Missing
pageData
- Missing
keypathregularPath
Global Components
- Missing
VitePress