快速开始
本模板的目标:复制一份就能得到一个功能完整的 VuePress 2 文档站。
1. 安装依赖
推荐使用 pnpm(本项目已通过 devEngines 锁定):
pnpm install也可以使用 npm 或 yarn,但请确保 Node 版本 ≥ 18。
2. 本地开发
pnpm dev默认会启动一个带有热更新的本地服务器,控制台会输出访问地址(通常是 http://localhost:8080)。
3. 构建与预览
# 构建产物输出到 .vuepress/dist
pnpm build
# 本地预览构建结果
pnpm clean-build自定义容器
模板内置三种自定义 Markdown 容器,方便写提示信息:
信息
用于补充说明,蓝色调。
笔记
用于额外笔记,紫色调。
注意
用于需要警惕的内容,黄色调。
同时默认主题自带的 tip / warning / danger 容器也仍然可用。
代码高亮
VuePress 2 使用 Shiki 进行代码高亮(VS Code 同款引擎):
export function greet(name: string): string {
return `Hello, ${name}!`
}echo "Shell 代码同样支持高亮"