用途:在 Git 同步仓库(GitHub、GitLab)、本地 Markdown 编辑器、IDE 集成等以文件方式编辑 GitBook 内容的环境中,编写、编辑和格式化 GitBook 文档页面。
主要能力:处理 GitBook 的页面、空间与集合结构;维护 README.md 首页与 SUMMARY.md 目录;使用 frontmatter 配置描述、图标、隐藏、布局、变量等;使用自定义块,如 {% tabs %}、{% hint %}、{% stepper %}、<details>、{% columns %}、{% updates %}、卡片表格、{% file %}、按钮、{% include %} 与表达式变量;支持空间变量(/.gitbook/vars.yaml)与页面变量。
使用方式:处理已有内容时先读 SUMMARY.md,无则浏览目录结构;检查 .gitbook.yaml、.gitbook/assets/ 与 .gitbook/vars.yaml。跨空间链接使用 https://app.gitbook.com/s/<spaceId>/<path>,未知空间 ID 时用 XSPACE_<KEY> 占位。Git Sync 下双向同步,冲突在 Git 中解决,结构性改动建议通过 Git 中的 SUMMARY.md 完成。
限制与注意:OpenAPI 规范须通过 UI、API、MCP 或 CLI 上传,不能嵌入 Markdown;同一文件不要在 SUMMARY.md 中重复引用;自定义块须正确闭合;frontmatter 必须位于文件顶部,含 :、# 等 YAML 特殊字符的 description 值须加引号,否则可能导致 Git Sync 静默失败;移动或重命名文件后需测试重定向。更详细的块语法、frontmatter、Markdown 与配置说明可按需加载 references 目录下的参考文件。