解决什么问题 · Problem
文档站是发布后最不起眼却最耗时的最后一公里;多数生成器只会复述 README、套一个与项目风格毫不相关的通用模板。
docs-site-gen 先读 globals.css / Tailwind 配置匹配你的视觉语言,再读路由、模型、服务构建可回溯到真实代码的功能清单——文档里每一项声明都有源文件对应;内容大纲经你审批后才生成页面;最后跑两轮完整性审计 + tsc + lint + i18n 键值一致性检查。默认 AI 友好:SSR 可 curl、章节锚点、自动生成 llms.txt。
怎么用 · How to use
一键安装(README 中的真实命令,自动检测已装的 AI 客户端):
git clone https://github.com/Octo-o-o-o/docs_site_gen.git
cd docs_site_gen && ./install.sh然后在你的项目里对 AI 说「生成文档站 / create docs site」,按 5 阶段走:设计系统检测(CP1 你审批设计方向)→ 项目与内容深挖 → 大纲规划(CP2 你审批内容大纲)→ 页面生成 → 验证(CP3)。三个检查点,没有你的认可什么都不会发布。
适用场景 · When to use
- Web 应用 / 后端 API / CLI / 库 / MCP Server 的文档站从零到一
- 代码变更后的文档增量更新(Edit 精准更新,保留自定义内容)
- 要求 AI 可读性(llms.txt + SSR + JSON-LD)的项目门户
- 双语(中英)文档站,全部文案走 i18n
开源仓库 github.com/Octo-o-o-o/docs_site_gen · GitHub 账号 Octo-o-o-o
去获取 →