文档总览
文档模块用于保存 app 的使用文档,以及和网站、部署、内容维护有关的其他说明资料。
文档分类
| 分类 | 内容 | 存放位置 |
|---|---|---|
| app 文档 | app 的使用说明、配置说明、常见问题 | docs/guide/app-name/ 或独立文档页 |
| 站点文档 | 网站运行、构建、部署、内容维护 | docs/guide/ |
| 其他文档 | 技术记录、规划说明、长期资料 | 根据主题放在合适目录 |
本地运行
bash
npm install
npm run dev启动后访问终端提示的本地地址即可预览网站。
常用命令
| 命令 | 说明 |
|---|---|
npm run dev | 启动本地开发服务 |
npm run build | 构建静态网站 |
npm run preview | 预览构建结果 |
现有入口
- 首页简介:
docs/index.md - 应用模块:
docs/apps/ - 文档模块:
docs/guide/ - 关于页面:
docs/about/ - 主题样式:
docs/.vitepress/theme/style.css