fix(docs): generate complete agent-readable Markdown exports (#121)

Co-authored-by: dadachann <[email protected]>
This commit is contained in:
Hyu
2026-09-06 12:01:09 +08:00
committed by GitHub
co-authored by dadachann
parent 84e8119428
commit 070ef2cff9
8 changed files with 447 additions and 5 deletions
+18
View File
@@ -32,6 +32,24 @@ npm run dev
文档构建为 `dist/public` 下的静态站点,并托管在 Cloudflare Pages。部署前会运行类型检查、文档契约测试及完整静态构建。
### Agent 可读导出
`npm run build` 会在 `/docs` 基路径和站点地图处理完成后生成 Agent 文本。
每个已发布页面都有 `.md` 副本,HTML 使用 `rel="alternate" type="text/markdown"`
声明该地址,不改变可视界面。
- `/docs/llms.txt`、`/docs/llms-full.txt`:全部语言的索引与完整正文。
- `/docs/{en,zh,ja}/llms.txt`、`llms-full.txt`:对应语言的索引与正文。
- 各目录的 `llm.txt` 是 `llms.txt` 的兼容别名。
- `/docs/openapi/service-api-{en,zh,ja}.json`:完整 API 规范。
生成器直接解析源 MDX 的 Markdown AST,保留提示标题和图片地址;每个 API
操作包含请求、响应、鉴权及递归引用的 schema。遇到未支持的语义 JSX 或可执行
表达式会中止构建,避免静默丢失正文。请修改 MDX/OpenAPI 源文件,不要编辑
`dist/public` 中的生成结果。`npm test` 检查转换逻辑,构建后的
`npm run test:static` 检查站点地图覆盖、HTML 发现链接、内部链接与 API 契约。
已有完成基路径处理的构建可使用 `npm run generate:agent-docs` 单独更新文本。
### 一些规范化标准
- 文件夹和文件的命名:**一律使用全小写,单词直接`-`隔开,如**`plugin-intro.mdx`