SuperAPI AI 工具集

gitbook

设计与创作

查看项目

更新于 10-15 21:52

技能介绍

用途:面向在 GitBook 中工作的团队,覆盖两类互补任务——站点编排(设计结构、搭建 Git 单仓库、驱动 GitBook REST API、应用品牌、交接 Git Sync 配置)与页面编写(GitBook 风格 Markdown:frontmatter、自定义块、变量、表达式、OpenAPI、跨空间链接)。

主要能力:创建新站点、重构或扩展已有站点、从其他文档平台迁移、在 Git 同步仓库或外部编辑器中编写内容、通过 REST API 管理空间与分区、自定义品牌。

使用方式:先读概览,再按任务打开对应参考文件。关键概念包括:Git Sync 只能通过 UI 配置,API 仅能读取其状态(GET /v1/spaces/{spaceId}/git/info);状态变更类 API 调用前须向用户展示预览并获明确确认;PAT 通过 op 读取,例如 export GITBOOK_TOKEN=$(op read "<secret-reference>"),不得写入文件或回显;跨空间链接先用 XSPACE_<KEY> 占位,空间创建后再替换为真实 ID;优先使用富块而非纯 Markdown。

适用场景:新建站点端到端、编辑 Git 同步内容、平台迁移、仅品牌变更。

限制:Git Sync 无法通过 API 设置;迁移时不要自动生成不存在的 frontmatter;不要按文件夹自动生成 SUMMARY.md;不要过度格式化 SUMMARY.md。缺失信息暂未提供。