SuperAPI AI 工具集

configure-site

设计与创作

查看项目

更新于 10-15 21:52

技能介绍

用途:端到端创建和维护整个 GitBook 文档站点,覆盖页面之外的结构设计、仓库脚手架、GitBook REST API 与品牌配置;需要生成或编辑页面内容时调用 write-docs 技能。

主要能力:设计空间列表、分区分组与页面树;按 monorepo 布局搭建仓库(每个空间含 README.md、SUMMARY.md,可选 .gitbook/vars.yaml 与 includes);通过 API 创建站点、空间、分区并应用品牌定制;支持 OpenAPI 自动生成 API 参考页;支持从 Mintlify、Docusaurus、ReadTheDocs 等平台迁移。

关键限制:GitBook REST API 无法配置 Git Sync,授权 GitHub/GitLab、选择仓库与分支、设置 monorepo 项目目录、选择初始同步方向均只能在 UI 完成,API 仅能读取同步状态(GET /v1/spaces/{spaceId}/git/info)。因此标准流程为:本地搭建仓库、API 创建站点与空间、用户在 UI 完成 Git Sync 绑定、API 应用品牌。若用户不需要 Git Sync,可改用 Imports API 与模板路径。

必要用法:所有 API 调用前需在环境中设置 GITBOOK_TOKEN,可用 [ -n "$GITBOOK_TOKEN" ] && echo "Token found" || echo "GITBOOK_TOKEN is not set" 检查;令牌不得写入文件、回显或提交。先列出组织(GET /v1/orgs)并确认目标组织。默认使用 type: site、Ultimate 计划、public 可见性,除非用户明确要求免费版。状态变更类 API 调用前须展示一屏预览并获得明确确认;删除操作需更明确确认。SUMMARY.md 应按用户确认的导航结构编写,README.md 作为同级首项,分组用 ## 标题,避免按文件夹机械生成。

适用场景:从现有 markdown 文件夹、笔记、竞品参考或描述构建文档站;重构已有站点;迁移其他文档平台;含 API 参考的站点。

暂未提供:具体价格、收费方案、平台支持范围及效果数据。