Appearance
Deploy
文档站发布
本目录为 VitePress 静态文档站,与业务前后端独立构建、独立部署。
本地开发
cd manual
cp .env.example .env.local # 可选:配置管理端文档密码
npm install
npm run dev默认地址:http://localhost:5173
管理端文档密码
访问 /admin/* 管理端手册时可启用密码验证;志愿者端、快速入门、部署说明等无需密码。
在 manual/.env.local(或构建环境变量)中设置:
MANUAL_ADMIN_PASSWORD=你的访问密码密码在构建时注入静态资源;修改密码后须重新 npm run build。验证状态保存在浏览器 sessionStorage,关闭标签页后失效(最长 8 小时)。
构建
cd manual
npm run build产物:manual/.vitepress/dist · 预览:npm run preview
生产部署(独立子域)
建议子域 https://docs.zsb.jluer.cn,Nginx 指向静态目录 /var/www/zsb-manual。
cd manual && npm ci && npm run build
sudo rsync -a --delete .vitepress/dist/ /var/www/zsb-manual/
sudo nginx -t && sudo systemctl reload nginx与主站同域(可选)
若需 https://zsb.jluer.cn/manual/,在 config.mts 设置 base: '/manual/' 后重新构建部署。
更新流程
- 01修改文档
同步更新 manual/ 下 Markdown 或 Vue 组件
- 02本地预览
npm run dev 确认
- 03构建发布
npm run build 并 rsync 到服务器
