在 VitePress(或者类似的静态站点生成工具)中,docs
、docs-build
和 docs-serve
是常见的命令,它们的功能如下:
1. docs
pnpm docs
或者
pnpm run docs
- 这个命令通常用于启动开发模式,即:
- 运行 VitePress 开发服务器
- 自动监听文件变更,实时热更新
- 本地预览 Markdown 文档
- 等价于:
vitepress dev
- 适用于:本地调试
2. docs-build
pnpm docs-build
或者
pnpm run docs-build
- 这个命令用于构建静态网站,即:
- 生成
dist/
目录(默认在docs/.vitepress/dist/
) - 预渲染 HTML 文件(适用于静态托管)
- 生成
- 等价于:
vitepress build
- 适用于:生产环境发布(如 GitHub Pages、Vercel、Netlify 等)
3. docs-serve
pnpm docs-serve
或者
pnpm run docs-serve
- 这个命令用于本地预览已构建的静态网站:
- 不会重新构建,而是直接从
dist/
目录启动一个服务器 - 方便在本地测试最终部署效果
- 不会重新构建,而是直接从
- 等价于:
vitepress serve
- 适用于:本地测试构建后的效果
区别总结
命令 | 作用 | 适用场景 |
---|---|---|
docs | 启动 VitePress 开发服务器,实时预览 | 开发调试 |
docs-build | 构建静态网站到 dist/ 目录 | 生产部署 |
docs-serve | 预览 dist/ 目录的构建结果 | 本地测试 |
如果你在开发阶段,就用 docs
;
如果你要生成静态文件,就用 docs-build
;
如果你想本地测试构建后的站点,就用 docs-serve
。