SuperAPI AI 工具集

manage-gitbook-site

设计与创作

查看项目

更新于 10-15 21:52

技能介绍

用途:端到端创建与维护整个 GitBook 文档站点。write-gitbook 负责单页内容,本技能负责页面之外的部分:结构设计、仓库脚手架、GitBook REST API 与品牌定制,需要生成或编辑页面内容时调用 write-gitbook。

核心限制:GitBook REST API 几乎能做所有事,唯独不能配置 Git Sync。授权 GitHub/GitLab、选择仓库与分支、为 monorepo 指定项目目录、选择初始同步方向都只能在 UI 操作;API 只能读取同步状态(GET /v1/spaces/{spaceId}/git/info)。因此推荐流程是:本地搭建 Git 仓库(条件允许时创建远端)、用 API 创建站点/分区/空 space、用户在 UI 完成 space 与目录的绑定、再用 API 应用品牌定制。若用户明确不要 Git Sync,可退回 Imports API 与模板路径。

前置输入:GitBook PAT(所有 API 调用必需,示例 export GITBOOK_TOKEN=$(op read "<secret-reference>"),令牌不得写入文件、回显或提交);组织(GET /v1/orgs 后由用户确认);站点方案与可见性(默认 Ultimate 的 type: site、public);内容来源(现有 markdown、笔记、描述、待重构站点或从其他平台迁移);OpenAPI 规范(有 API 参考时优先用 builtin:openapi,而非手写端点页);品牌(主色等);站点结构(分区标题、Font Awesome 图标名、描述);Git 远端偏好;单 space 或多 space。

结构设计:先产出 space 列表(通常 1–4 个)、分区分组、每个 space 的页面树,并向用户确认后再搭建文件。

仓库脚手架:采用 monorepo,每个 space 一个目录,含 README.md 与 SUMMARY.md,可选 .gitbook/vars.yaml 与 .gitbook/includes/。SUMMARY.md 应按用户确认的导航编写,README.md 作为同级首行,用 ## 分组标题,避免机械地按文件夹生成嵌套树。

确认门:站点创建、space 创建、添加分区、绑定 site-space、定制 PUT 及 DELETE 等状态变更调用,必须先展示一屏预览并获得明确同意;只读 GET 无需确认。

限制:Git Sync 无法通过 API 配置;令牌仅经 op 读取;缺失信息需向用户询问,不应猜测。