前端 - VitePress

文档 #

• VitePress - 官网
• emoji list - GitHub
• 代码块语言列表 - shiki

初始化 #

::: code-group

# 安装到根目录
$ pnpm add vitepress -Dw

# 进入项目目录
$ pnpm init
$ pnpm vitepress init

$ npm init
$ npm i -D vitepress
$ npx vitepress init

:::

功能 #

环境变量 #

切换页面加载提示 #

• nprogress - GitHub

生成 sidebar #

• fast-glob - GitHub
• gray-matter - GitHub

读取文件中 front-matter 的 title，生成 sidebar

支持 Task list #

• TODO list todo is not supported - GitHub
• Markdown Advanced Configuration - VitePress

Badge 报错 #

• Badge component does not work - GitHub

增加 sitemap #

• Sitemap Generation - VitePress
• Build Hooks - VitePress
• sitemap - Google文档
• robots.txt - Google文档
• 使用 noindex 阻止搜索引擎编入索引 - Google文档

设置title和description #

使用transformPageData的hook，根据以下优先级设置title和description：

1. .md页面配置的
2. router中设置的
3. package.json设置的