快速开始
环境要求
- Node.js >= 18.0.0
- npm >= 9.0.0
安装依赖
bash
npm install开发模式
启动开发服务器：
bash
npm run dev访问 http://localhost:5173 查看网站。
构建
构建生产版本：
bash
npm run build构建产物将输出到 docs/.vitepress/dist 目录。
预览
预览生产构建：
bash
npm run preview添加文档
- 在
docs/guide/或docs/api/目录下创建.md文件 - 在
docs/.vitepress/config.ts中更新导航和侧边栏配置 - 重新启动开发服务器查看效果
自定义配置
编辑 docs/.vitepress/config.ts 文件自定义：
- 站点标题和描述
- 导航菜单
- 侧边栏
- 主题配置
- 社交链接 等