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