快速开始
环境要求
- Node.js 18 及以上
- npm / pnpm / yarn 任选其一
常用命令
bash
# 本地预览(带热更新)
npm run docs:dev
# 构建静态站点,产物在 docs/.vitepress/dist
npm run docs:build
# 预览构建产物
npm run docs:preview1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
新增一篇文档
- 在对应集合的文件夹里新建
.md文件; - 打开
docs/.vitepress/config.mts,在sidebar里补一条; - 保存,浏览器会自动刷新。
新增一套文档
假设要再加一套「读书笔记」:
- 新建文件夹
docs/reading/,里面放index.md和若干篇.md; - 在
nav里加一个入口,指向/reading/; - 在
sidebar里加一个'/reading/'键,配上这一套的目录。
具体写法见目录结构。