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