SuperAPI AI 工具集

gitbook

写作与研究

查看项目

更新于 10-16 03:38

技能介绍

用途:GitBook 用于发布专业文档与书籍,适合团队协作文档、产品文档、用户指南、API 文档、教程、内部知识库、多版本文档等场景。教程建议需要与 GitHub/GitLab 同步、自定义品牌与访问控制、快速搭建文档时使用;复杂代码文档建议 Sphinx,静态站点控制建议 MkDocs/Docusaurus,离线优先或必须自托管时不建议使用(GitBook 以云托管 SaaS 为主,旧版自托管已弃用),免费层有额度限制。

主要能力:通过 REST API(基址 https://api.gitbook.com/v1)管理用户、组织、空间、内容、集合与变体。认证使用 API Token,先设置环境变量 export GITBOOK_API_TOKEN="gb_api_xxx",再以 curl -H "Authorization: Bearer $GITBOOK_API_TOKEN" 调用。可列出组织、创建/更新/删除空间、读取页面与导出内容、从 Git 导入、搜索内容、创建集合并关联空间、创建内容变体并设为主版本。

使用方式:官方资料提供 Python 客户端示例,安装 pip install requests python-dateutil(或 uv pip install),封装 _request 方法统一发请求。Git 同步在空间设置 Integrations > Git Sync 连接仓库与分支,仓库可含 README.md、SUMMARY.md、章节目录及可选 .gitbook.yaml(配置 root、structure、redirects)。

限制:资料未提供具体定价、各套餐额度与平台覆盖细节,需以官方为准;API 端点与字段可能变化,使用前应核对最新文档。