Skip to content

文档站维护与补充方法 ​

本页面向文档维护者,帮助后续功能变更继续反映在手册里,而不是再次积累过时短说明。

文件结构 ​

text
index.md                  首页与阅读入口
docs/intro/               快速开始、架构与术语
docs/install/             控制端、容器、HTTPS
docs/servers/             Agent 与服务器管理
docs/nodes/               节点、转发、域名和分享
docs/users/               用户、套餐、门户
docs/features/            DNS、证书、流量、模板、设置
docs/security/            登录与 SSO
docs/operations/          备份、更新、排错
docs/reference/           速查、API、版本与维护
public/images/            界面图与 SVG 关系图
.vitepress/config.mts     导航、搜索和站点配置

本地预览与构建 ​

bash
npm ci
npm run docs:dev
npm run docs:build
npm run docs:preview

更新依赖时同步 lockfile。构建产物在 .vitepress/dist,不把 node_modules 和构建缓存作为源文件提交。

新增一篇说明 ​

写清“适合谁、先决条件、在哪里操作、字段含义、成功验证、失败处理及边界”。标题按真实任务命名,截图用演示资源;不要用无法验证的“零配置、绝不、完全一致、无损”代替具体说明。

新页面需要加入侧栏并被相关章节链接。旧 URL 尽量保留,避免已分享地址失效。页面内部链接优先使用站内路径。

图片标准 ​

优先使用当前前端构建与隔离样例数据生成截图。使用 example.com 和文档地址段,图注标明演示数据。二维码即便含假密码也注明不可用于实际接入。

关系图使用 SVG,可缩放、有文本与说明;手机上允许图表横向滚动,别把图中文字缩到无法读。图片不要依赖第三方临时 URL。

发布检查 ​

  1. 构建无死链接,页面标题、侧栏和搜索可用。
  2. 所有内部锚点与图片能打开。
  3. 桌面和手机没有整页横向溢出。
  4. 源码和产物不含真实密码、令牌、私钥、生产二维码。
  5. 备份线上原文件,先上传新发布目录,再切换静态入口。
  6. 检查首页和代表性章节、图片、搜索,保留回退目录。

文档部署只涉及静态站,不应修改 RelayDock 业务数据库、Agent 或代理监听。

操作示例与截图均使用演示数据 · 内容核对于 2026-11-20