与 VuePress 的区别
优质
小牛编辑
133浏览
2023-12-01
VitePress 和 VuePress有不同的 设计目标. 这两个项目都有相似的配置命名约定。VitePress的目标是拥有编写文档所需的最低限度功能。其他功能放在主题中实现。另外一方面,VuePress有更多的现成功能,包括由它的插件的生态系统启用的功能。
提示
如果你正在使用VuePress,则不需要迁移到VitePress。将来,这两个项目将继续共存。
警告
注意,VitePress 是早期的WIP!目前的重点首先是让Vite稳定和功能完善。目前,不推荐将其用于任何正式的场景。
如果你决定将项目迁移到VitePress,下列是你需要考虑到的与 VuePress v1.7.1的不同之处。
General
- 去除
- 站点配置格式不再使用YAML 和 TOML 格式。
.vitepress/config.js
仅支持JavaScript
。 - Plugins 支持。VitePress中的这些功能在主题中实现。
- permalink support
.vitepress/templates
- 在
.vitepress/components
的组件不在作为全局组件自动注册
- 站点配置格式不再使用YAML 和 TOML 格式。
- 不同点
Markdown
- 去除
- 支持 toml in frontmatter
- 详情块
- markdown 插槽 guide/using-vue.html#using-components).
~
前缀显示指定URL是 webpack模块要求
站点配置
- 去除
temp
dest
- 来自依赖的
theme
permalink
port
shouldPrefetch
cache
extraWatchFiles
patterns
plugins
markdown.pageSuffix
markdown.slugify
markdown.plugins
markdown.extractHeaders
markdown.extendMarkdown
tomarkdown.config
configureWebpack
,chainWebpack
,postcss
,Stylus
,scss
,Sass
,less
配置evergreen
默认主题配置
- 去除
smoothScroll
displayAllHeaders
activeHeaderLinks
sidebarDepth
andinitialOpenGroupIndex
for sidebar groups
- 区别
searchMaxSuggestions
改为search.maxSuggestions
algolia
改为search.algolia
searchPlaceholder
改为search.placeholder
默认主题
全局计算属性
- 去除
$lang
$localePath
Frontmatter预定义变量
- 去除
description
meta
metaTitle
lang
layout
permalink
canonicalUrl
Frontmatter默认主题变量
站点数据
- 去除
页面数据
- 去除
key
path
regularPath
全局组件
- 去除