参与文档站

更新: 2026/10/10字数: 635 字时长: 2 分钟

这个站是 VitePress 站点，中文是权威内容源，英文是镜像。 改文档只要动 Markdown，不用碰主题；但有几条硬规则必须遵守，否则 CI 的构建检查会直接失败。

仓库结构

zh/ — 中文文档（权威）。改内容先改这里。
en/ — 英文镜像，目录结构与 zh/ 一一对应。
.vitepress/ — 站点配置：config.mts（导航与插件）、sidebar/（侧边栏）、theme/（主题与组件）、markdown/（自定义 Markdown 插件）。
public/ — 静态资源：images/、title_img/、avatars/。

内容分区：

manual/ — 用户手册：部署、适配器、配置、插件安装、WebUI。
develop/ — 接入文档：适配器、插件接入、程序化对接（WebUI API）、数据统计；模型与 MCP 的配置说明归 manual/configuration/。
plugin/ — 插件开发文档（权威统一入口）。
contributing/ — 本页所在的文档站协作规范。
faq/ changelog/ about/ — 常见问题、更新日志、项目元信息。

pnpm构建

bash

pnpm install
pnpm docs:dev      # 本地预览，改文件即时刷新

bash

pnpm docs:build    # 构建整站，同时生成 llms.txt

提交前必须跑一次 pnpm docs:build：它不只是打包，还会校验死链、容器语法和代码片段导入路径。

中文先行，英文同步 — 改了 zh/ 的内容页，同一个 PR 里要同步 en/ 镜像。术语、代码、文件名保持一致，散文可以重写。
新页面必须注册导航 — 同时改 .vitepress/sidebar/zh.ts 与 .vitepress/sidebar/en.ts（英文侧链接带 /en/ 前缀），需要时再改 config.mts 的顶部导航。
图片放 public/images/，正文用 /images/xxx.png 引用；头像与标题图放 public/avatars/、public/title_img/。
写法三禁 — 内容页不用 Markdown 表格（改用定义列表）、独立外链不用裸链接（改用 <Linkcard>）、独立代码块不裸写（包进 ::: code-group 并显式给图标）。细则见文档编写特性。

验收动作 — pnpm docs:build 无报错，且你新增的页面能从侧边栏点进去。