SuperAPI AI 工具集

write-gitbook

通用与其它

查看项目

更新于 10-16 06:18

技能介绍

用途:在 GitBook UI 之外(Git 同步仓库、本地 Markdown 编辑器、IDE、命令行)以文件形式编辑 GitBook 文档。

主要能力:说明 GitBook 内容结构(页面、空间、集合)与目录布局,包括 .gitbook/(assets、includes、vars.yaml)、.gitbook.yaml、README.md、SUMMARY.md;介绍 frontmatter 字段(description、icon、hidden、cover、coverY、vars、if、layout 等);变量与表达式(空间级 .gitbook/vars.yaml、页面级 frontmatter,语法如 space.vars.variableName);常用自定义块(tabs、hint、stepper、details、columns、updates、file、include、button、表达式);链接规则(外部链接、同空间相对路径、跨空间需用 https://app.gitbook.com/s/<spaceId>/<path>,未知空间 ID 可用 XSPACE_<KEY> 占位);Markdown 格式(GFM、带标题代码块、TeX 公式、Mermaid 图、SVG 处理注意事项);SUMMARY.md 的目录写法与规则;.gitbook.yaml 配置(root、structure.readme、structure.summary、redirects)与 monorepo 支持。

使用方式:处理已有内容时先读 SUMMARY.md 了解结构,再查看 .gitbook.yaml、.gitbook/assets/、.gitbook/vars.yaml;本地编辑后在 GitBook 中测试,保持 SUMMARY.md 与文件结构同步;OpenAPI 规范需通过 API/CLI/UI 上传,不能嵌入 Markdown。

适用场景:Git 同步的 GitBook 文档维护、迁移与批量编辑。

限制:跨空间相对路径无效;同一 Markdown 文件不能在 SUMMARY.md 中引用两次;.gitbook/includes 可能出现在目录中需手动隐藏;frontmatter 中含特殊字符的字符串值需加引号,否则 Git Sync 会静默失败;自适应内容条件建议在 UI 中配置。部分细节(如具体命令)资料暂未提供。