vitepress/docs/guide/differences-from-vuepress.md

sidebarDepth
2

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/components are not auto registered as global components
• Differences
  • Public files that are directly copied to dist root moved from .vitepress/public/ is public/
  • styling .vitepress/styles/index.styl and .vitepress/styles/palette.styl is not supported. See Customizing CSS.
  • App Level Enhancements API, app enhancements .vitepress/enhanceApp.js is now done in .vitepress/theme/index.js. See Extending the Default Theme.

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
  • temp
  • dest
  • theme from a dependency
  • permalink
  • port
  • shouldPrefetch
  • cache
  • extraWatchFiles
  • patterns
  • plugins
  • markdown.pageSuffix
  • markdown.slugify
  • markdown.plugins
  • markdown.extractHeaders
  • markdown.extendMarkdown to markdown.config
  • configureWebpack, chainWebpack, postcss, Stylus, scss, Sass, less configs
  • evergreen

Default Theme Config

• Missing
  • smoothScroll
  • displayAllHeaders
  • activeHeaderLinks
  • sidebarDepth and initialOpenGroupIndex for sidebar groups
• Differences
  • searchMaxSuggestions is search.maxSuggestions
  • algolia is search.algolia
  • searchPlaceholder is search.placeholder

Default Theme

• Missing
  • <code-group> and <code-block>

Computed Globals

• Missing
  • $lang
  • $localePath

Frontmatter Predefined Variables

• Missing
  • description
  • meta
  • metaTitle
  • lang
  • layout
  • permalink
  • canonicalUrl

Frontmatter Default Theme Variables

• Missing
  • prev, next
  • search
  • tags
  • pageClass
  • layout

siteData

• Missing
  • pages

pageData

• Missing
  • key
  • path
  • regularPath

Global Components

• Missing
  • <Badge>