SuperAPI AI 工具集

docs-ssot

写作与研究

查看项目

更新于 10-15 22:13

技能介绍

用途:docs-ssot 把现有 Markdown 文档迁移为模块化 SSOT 结构(由 docs-ssot 管理),随后生成并校验输出文件。适用于在新建或既有仓库中搭建 docs-ssot、为已有 SSOT 结构新增生成文件(如 SETUP.md)、或在修改源模板后重新生成文档。

主要能力:migrate 按 H2 拆分文档为 template/sections/ 下的 section 文件,并在 template/pages/ 生成含 @include 的模板,创建或更新 docsgen.yaml;validate 干跑检查所有 include 是否可解析;build 从模板生成全部输出;check 检测近似重复 section;index 展示 include 关系与孤立检测;include 将模板展开到 stdout 便于调试。

使用方式:先确认工具存在(docs-ssot version,jq --version,yq --version),缺失时可 brew tap hiromaily/tap && brew install docs-ssot,或 go install github.com/hiromaily/docs-ssot/cmd/docs-ssot@latest。迁移前检查是否已有 docsgen.yaml 与 template/sections/,已迁移则勿对生成输出运行 migrate。先 docs-ssot migrate --dry-run README.md CLAUDE.md 预览,再 docs-ssot migrate README.md CLAUDE.md AGENTS.md。之后 docs-ssot index 审查结构、docs-ssot check 查重,最后 docs-ssot validate 与 docs-ssot build(或 make docs),用 git diff 核对。

约定与限制:section 文件以 H2 起头,作为独立输出时可用 level=-1 调整;勿直接编辑生成文件,构建会覆盖;新增输出文件需在 docsgen.yaml 注册并在模板中 include 已有 section 而非复制。资料还提供 VitePress 集成、Claude Code 生成文件保护钩子、lefthook 预推送检查与 README 说明等可选增强,具体配置以原文为准。