核心概念
学习 GitBook 的基础知识，以便为你的用户创建并发布出色的文档
组织内容
部分
部分是一个项目，让你可以处理一组相关页面。在一个部分中，你可以编写内容，使用页面组和子页面整理页面，安装集成，等等。
部分属于一个文档站点，你可以根据需要向一个文档站点添加任意多个部分。因此，在构建内容时，你可以为产品文档、API 参考、更新日志、帮助中心以及你想在文档中包含的其他内容创建独立部分——并将它们全部发布在同一个文档站点上。
你也可以创建主要文档的翻译版本，或为产品的不同版本创建独立文档。这些内容也都会拥有各自的部分，并且可以添加到你的单一文档站点中供用户浏览。
分组
分组在 GitBook 应用中就像文件夹一样，让你将相关部分放在一起，更容易整理和存储内容。
除了帮助你整理内容外，分组还让你更容易大规模管理内容级权限。你可以将多个部分添加到一个分组中，并为整个分组设置权限，从而覆盖组织级权限。
文档站点
你可以将内容发布为文档站点。你的文档会作为一个网站发布，并提供给你选定的受众，你可以使用自己的品牌、分析工具和自定义域名进行定制。
你可以创建任意多个文档站点。它们都会列在侧边栏和应用中的“文档站点”部分，你可以在这里更改设置和自定义选项。你可以在 GitBook 应用中控制文档站点的所有设置和选项。
你站点上的内容存放在各个部分中。创建新的文档站点时，你可以创建一个新部分，或者添加现有内容。一个文档站点可以包含一个部分，也可以包含多个不同内容的部分——包括翻译内容和之前的产品版本。
编辑内容
GitBook 的可视化编辑器让你可以使用所见即所得（WYSIWYG）界面向部分中添加内容。
可在台式机和笔记本电脑设备上进行编辑。你可以在智能手机上查看你的组织和内容，但编辑需要台式机或笔记本电脑。
页面
页面是你添加、编辑和嵌入内容的地方。页面始终位于某个部分中，你可以根据需要向一个部分添加任意多个页面。
你部分中的页面会显示在编辑器左侧的目录中。在这里，你可以添加新页面、创建页面组，并将页面嵌套到其他页面中以创建子页面。
看不出如何编辑或添加页面？
如果你的站点已发布，在你更改部分内容之前，需要先创建变更请求。 请在下方阅读有关变更请求的内容.
区块
GitBook 是一个基于区块的编辑器。这意味着你可以向页面添加不同类型的区块——从标准文本和图片到更高级的交互式区块。你的页面可以包含你想要的任意区块组合，而且页面上的区块数量没有限制。
基于区块的编辑方式让你可以通过拖放轻松重新组织内容，或在现有内容中间添加新区块。你可以使用编辑器界面创建新区块，也可以使用 Markdown 创建并格式化区块。
了解你可以在 GitBook 中使用的所有区块 在“区块”部分中.
Markdown 编辑
GitBook 的编辑器允许你使用 Markdown 创建并格式化内容区块。
Markdown 是一种流行的标记语法，以其简洁性而广为人知。GitBook 支持它作为一种便于键盘输入的方式来编写丰富且结构化的文本——GitBook 的所有区块都可以使用 Markdown 语法编写。
Git Sync
Git Sync 允许团队将 GitHub 或 GitLab 仓库与 GitBook 同步，并将 Markdown 文件转换为美观、易用的文档。设置完成后，它会在 GitBook 应用与代码库之间保持所有内容同步。
Git Sync 是双向的，因此你在 GitBook 可视化编辑器中所做的更改会自动同步——GitHub 或 GitLab 上的任何提交也一样。这使开发者可以直接从 GitHub 或 GitLab 提交，而其他团队成员则可以在 GitBook 中直接编辑并对更改留下反馈。
Git Sync 还为你的 GitBook 文档解锁了许多其他实用工作流，例如批量更改、lint 检查等等。了解更多，请参阅 我们的 Git Sync 部分.
编辑流程
变更请求
变更请求是你主内容的一个 分支 ，你可以用它来进行并发编辑，同时保留版本历史。对于任何使用 GitHub 拉取请求或 GitLab 合并请求的人来说，这都会很熟悉。
如果你想编辑已发布文档站点上的内容，首先需要在你的部分中打开一个变更请求。
在变更请求中，你可以在一个部分内添加、编辑和删除内容，然后向团队请求审核，并将你的更改合并到主内容中，以更新你已发布的文档站点。
分支简述
打开变更请求会在那个特定时刻创建一份内容副本，有时也称为“分支”。在你选择合并变更请求之前，你所做的任何更改都不会出现在主内容中。
分支的优势在于，你的队友可以在不互相干扰的情况下，同时创建、编辑并合并自己的变更请求。如果有人编辑了与你相同的内容，GitBook 会在你合并之前引导你解决任何冲突。
审核
审核鼓励监督，并帮助提高文档的质量和准确性。
在合并并让更改在文档站点上生效之前，你可以先为变更请求请求审核。为变更请求添加标题和描述可以为审核者提供一些上下文。
审核者可以查看你的变更请求的差异，其中会突出显示变更请求中所有新增、修改或删除的内容。他们还可以使用内置评论功能直接在页面上留下反馈——然后批准你的变更请求，或要求进一步修改。
合并
合并变更请求会将变更请求中的所有内容添加到内容的主分支中——这些更改也会立即在你的文档站点上生效。
当你合并变更请求时，它还会在该部分的版本历史中创建一个新版本。
发布文档
当你将内容发布为 文档站点时，你可以向站点添加更多内容、更改受众，并自定义其外观、体验和其他设置。
构建你的文档站点结构
如果你想向站点添加额外内容，有两个可供使用的选项，每个都针对不同用例而设计：部分和变体。
站点结构中的部分
部分让你可以向 单个文档站点添加多种不同类型的文档。例如，你可以使用一个文档站点来承载产品文档、API 参考、帮助中心和更新日志——就像我们在这个文档站点上所做的那样。
当你添加新部分时，你会构建站点顶部的导航栏，每个部分都会在导航栏上获得自己的条目。你也可以将部分保留在一个 分组 中，以在导航栏中创建下拉菜单——非常适合为站点添加层级结构。
变体
变体旨在让你可以向 单个文档站点添加同一文档的多个版本。例如，你可能希望将整套文档本地化为多种语言，或者为尚未更新的用户记录产品的旧版本。
最终用户可以在你的文档站点上使用左侧目录顶部的语言选择器或变体选择器，在这些变体之间切换。
站点受众
你可以选择在发布文档时谁可以看到它。新站点的默认设置是公开发布，并被搜索引擎索引。
不过，如果你想更好地控制谁可以访问你的站点，你可以选择使用以下方式限制受众： 共享链接 或 经身份验证的访问.
使用共享链接，你可以通过创建一个私密链接并直接分享给客户或合作伙伴，而无需邀请他们加入你的组织，从而私下共享内容。任何拥有该链接的人都可以访问你的站点。
如果你想要更多控制，经身份验证的访问允许你在发布内容的同时，要求任何想要查看内容的访客进行身份验证。启用后，GitBook 会让你的身份验证提供商负责管理谁有权访问内容。这非常适合私密内容，或发布仅团队成员可访问的内部知识库。
你也可以使用一种名为自适应内容的功能来控制谁能看到单个页面或区块。设置完成后，它会根据你决定的用户属性显示或隐藏内容。更多信息请参阅 自适应内容页面.
站点自定义
GitBook 为文档站点提供内置自定义选项，帮助你让文档的外观和体验与你的产品或品牌保持一致。
即使你不应用任何自定义，文档本身也会很好看。但你也可以自定义徽标、图标和颜色，添加自定义字体，或者从一些内置主题中进行选择，使你的文档看起来和你的产品一样出色。
SEO 和 AI 优化
在 GitBook 中发布的文档会自动针对搜索（SEO）以及 ChatGPT、Claude 和 Google AI Overview（GEO）等 AI 系统进行优化。这些都在后端处理，所以你只需要编写包含你想要定位的关键词和术语的内容。
页面会从每个页面的标题和描述中提取元数据，且你的内容会被格式化为响应式。GitBook 会根据你的目录自动创建站点地图，页面则通过我们的全球 CDN 缓存和提供，以提升性能。所有这些都有助于让你的文档在搜索引擎中获得更高排名。
同样，GitBook 也会根据所有不断演进的行业标准，为 AI 工具进行优化。
GitBook 会自动为每个页面创建 .md 版本，这让大型语言模型（LLM）更容易解析。我们还会为每个已发布站点自动提供一个模型上下文协议（MCP）服务器，为 AI 工具提供一种结构化方式来发现和检索你的文档作为资源——无需抓取。此外，你的站点还会生成 llms.txt 以及 llms-full.txt 专为 AI 摄取而设计。
团队管理
组织
一个 GitBook 组织包含某个公司的所有内容和文档站点。使用同一个账号，你可以成为一个或多个组织的成员，并通过侧边栏顶部的组织菜单在它们之间切换。
成员
成员是你组织中的个人用户。你可以在一个组织中拥有任意多的成员，每个成员都拥有适合其具体访问需求的权限。
权限
权限让你决定组织成员的访问级别。成员加入组织时，你会为他们分配一个角色——例如编辑者或查看者。这些角色定义了他们对组织所有内容的权限。但你也可以在内容级别覆盖这些权限。例如：
你可以为拥有查看者角色的人授予某一特定内容的编辑权限
你可以限制对特定机密或私密内容的访问，并且只向组织中的某些成员授予访问权限。
更多内容请参阅 权限与继承页面.
最后更新于
这有帮助吗？