SuperAPI AI 工具集

gitbook

写作与研究

查看项目

更新于 10-15 21:38

技能介绍

用途:GitBook 是 AI 原生文档平台,用于创建、发布和管理产品文档、API 参考与知识库。本技能在需要编写 GitBook 内容、配置 Git Sync、发布文档站点、启用 AI 功能或排查同步与权限问题时使用。

主要能力:内容层级为组织→集合→空间→页面→区块,编辑器以 / 插入段落、标题、代码块、提示框、表格、标签页、折叠、步骤、卡片、图片、嵌入、可复用内容、OpenAPI、绘图、数学公式等区块。支持从 Confluence、Notion、GitHub/GitLab 及 Markdown、HTML、Word、CSV 导入。Git Sync 可与 GitHub 或 GitLab 双向同步,仓库根目录的 .gitbook.yaml 可配置 root、structure(readme、summary)与 redirects,支持 monorepo 子目录和 PR 预览。发布方面支持单空间站点、站点分区、内容变体、自定义域名(需 CNAME 指向 hosting.gitbook.io,SSL 自动配置)、可见性设置、主题与自定义 CSS、PDF 导出。协作采用变更请求(类似 PR)与级联角色权限,支持评论与 @提及。AI 功能包括 AI 搜索、GitBook Agent(在变更请求中生成与修改内容)和 AI Insights。开发者可通过 API 令牌调用 /v1 接口,或用 @gitbook/runtime 构建集成;Docs Embed 可将文档嵌入产品。

使用方式:在 app.gitbook.com 注册并创建空间,用 / 插入区块;空间右上角 Configure 中启用 GitHub Sync 并选择仓库、分支与同步方向;站点设置中配置域名、可见性与搜索;API 调用示例:curl -H "Authorization: Bearer YOUR_TOKEN" https://api.gitbook.com/v1/user。

适用场景:产品文档、API 参考、知识库、多版本文档与多语言翻译、文档站发布与嵌入。

限制:可复用内容、AI 搜索、GitBook Agent 等需 Pro 或 Enterprise 计划;自定义域名需 Premium 及以上;自定义子目录需 Cloudflare Workers、Vercel 或 AWS CloudFront 代理;自定义 CSS 需 Ultimate 计划。具体价格与配额资料未提供。