概念
了解 GitBook 的基础知识，以便为您的用户创建并发布出色的文档
组织内容
空间
空间是一个项目，让您可以在一组相关页面上进行工作。在空间内，您可以撰写内容、使用分组和子页面组织页面、安装集成等。
当您想发布一个空间时，可以通过将其添加到文档站点来实现。您可以向一个文档站点添加任意多个空间。因此在构建内容时，您可以为产品文档、API 参考、更新日志、帮助中心以及您希望包含在文档中的任何其他内容创建单独的空间——并将它们全部发布在同一个文档站点上。
您也可能希望为主要文档创建翻译版本，或为产品的不同版本创建单独的文档。这些每一个也会有自己的空间，并且可以添加到您的单一文档站点，供用户浏览。
集合
集合在 GitBook 应用中类似于文件夹，允许您将空间分组在一起，以便更容易组织和存储内容。
除了帮助您保持内容井然有序外，集合还使大规模管理内容级权限变得更容易。您可以通过将多个空间添加到集合并为整个集合设置权限，覆盖组织级别的权限。
文档站点
您可以将内容以文档站点的形式发布。您的文档将作为一个网站发布并对您选择的受众可用，您可以使用自己的品牌、分析和自定义域名对其进行定制。
您可以创建任意多个文档站点。它们都会列在侧边栏和应用的“文档站点”部分，您可以在其中更改设置和自定义选项。您可以在 GitBook 应用中控制所有文档站点的设置和选项。
站点上的内容来自您 GitBook 组织中的空间。当您创建新文档站点时，可以创建一个新空间或链接现有空间。一个文档站点可以包含一个空间，或包含多个具有不同内容的空间——包括翻译和以前的产品版本。
编辑内容
GitBook 的可视化编辑器让您使用所见即所得（WYSIWYG）界面向空间添加内容。
页面
页面是您添加、编辑和嵌入内容的地方。页面始终存在于空间中，您可以向一个空间添加任意多的页面。
空间中的页面会显示在编辑器左侧的目录中。在这里，您可以添加新页面、创建页面组，并将页面嵌套在其他页面中以创建子页面。
看不到如何编辑或添加页面？
如果您的站点已发布，在对空间内容进行任何更改之前，您需要先创建变更请求。 在下面阅读有关变更请求的内容.
区块
GitBook 是基于区块的编辑器。这意味着您可以向页面添加不同类型的区块——从标准文本和图像到更高级的交互式区块。您的页面可以包含任意组合的区块，并且页面上的区块数量没有限制。
基于区块的编辑使得通过拖放重新组织内容变得容易，或在现有内容中间添加新区块。您可以使用编辑器界面创建新区块，或使用 Markdown 创建和格式化区块。
在区块部分发现您可以在 GitBook 中使用的所有区块 在“区块”部分.
Markdown 编辑
GitBook 的编辑器允许您使用 Markdown 创建和格式化内容区块。
Markdown 是一种以简洁著称的流行标记语法。GitBook 支持它作为一种键盘友好的方式来编写丰富且结构化的文本——GitBook 的所有区块都可以使用 Markdown 语法来编写。
Git 同步
Git 同步允许团队将 GitHub 或 GitLab 仓库与 GitBook 同步，并将 Markdown 文件转换为美观、用户友好的文档。一旦设置，它会在 GitBook 应用与您的代码库之间保持所有内容的同步。
Git 同步是双向的，因此您在 GitBook 可视化编辑器中所做的更改会自动同步——在 GitHub 或 GitLab 上所做的任何提交也是如此。这允许开发者直接从 GitHub 或 GitLab 提交，而其他团队成员则可以在 GitBook 中编辑并对更改留下反馈。
Git 同步还在您的 GitBook 文档中解锁许多其他有用的工作流程，例如批量更改、lint 检查等。更多信息请参见 我们的 Git 同步部分.
编辑流程
变更请求
变更请求是您主内容的一个 分支 ，可用于进行并发编辑，同时保留版本历史。对任何使用 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 组织包含某个公司的所有内容和文档站点。使用您的单一账户，您可以成为一个或多个组织的成员，并通过 GitBook 应用左上角的下拉菜单在它们之间切换。
成员
成员是组织内的个别用户。一个组织中可以有任意多的成员，每个成员拥有适合其特定访问需求的权限。
权限
权限让您决定组织成员的访问级别。当成员加入组织时，您会为他们分配一个角色——例如编辑者或查看者。这些角色定义了他们对组织所有内容的权限。但您也可以在内容层级覆盖这些权限。例如：
您可以授予具有查看者角色的某人对某一特定内容的编辑访问权限
您可以限制对特定机密或私人内容的访问并仅授予组织中某些成员访问权限。
阅读更多内容请参见 权限与继承页面.
最后更新于
这有帮助吗？