Skip to content

持续维护指南

本项目采用「Markdown 写作 + VitePress 构建 + 静态服务器托管」的方式维护新人手册。

日常修改流程

  1. 修改 docs/ 目录下的 Markdown 文件。
  2. 运行本地预览:
bash
npm run docs:dev
  1. 在浏览器检查页面、目录、代码块和表格。
  2. 构建静态站点:
bash
npm run docs:build
  1. docs/.vitepress/dist/ 发布到服务器。

写作约定

  • 每个页面只负责一个主题,避免单页过长。
  • 操作步骤用编号列表,规则和注意事项用无序列表。
  • 命令统一放进代码块,并标注 shell 类型。
  • 服务器地址、账号、License、密码等敏感信息不要写进公开仓库。
  • 对需要负责人补充的信息,先用明确占位说明,例如「请服务器管理员补充」。

后续拆分建议

当前 guide/full-handbook.md 保留了原始手册全文。内容稳定后,建议逐步拆分:

text
docs/guide/
  onboarding.md
  rules.md
  accounts.md
  windows-env.md
  server.md
  hardware.md
  git.md
  ai-tools.md

拆分后,在 docs/.vitepress/config.ts 里补充侧边栏链接即可。