# 概念

An illustration showing the block palette open in the GitBook editor. The window is floating on a pastel yellow and pink background

## 组织内容 ### 空间空间是一个项目，让你可以处理一组相关页面。在空间中，你可以撰写内容，使用分组和子页面整理页面，安装集成等。当你想发布一个空间时，可以将其添加到文档站点中。你可以随意向一个文档站点添加任意多个空间。因此，在构建内容时，你可以为产品文档、API 参考、更新日志、帮助中心以及你想包含在文档中的任何其他内容创建单独的空间——并将它们全部发布到一个文档站点上。你也可能希望创建主要文档的翻译版本，或针对产品不同版本创建独立文档。每一个版本也都会有自己的空间，并可添加到你的单一文档站点中供用户浏览。 #### 集合集合在 GitBook 应用中类似于文件夹，允许你将多个空间归组在一起，以便更轻松地组织和存储内容。除了帮助你整理内容之外，集合还使你能够更轻松地大规模管理内容级权限。你可以将多个空间添加到某个集合中，并为整个集合设置权限，从而覆盖组织级权限。 ### 文档站点你可以将内容发布为文档站点。你的文档将以网站形式发布并向你选定的受众开放，你可以使用自己的品牌、分析工具和自定义域名进行定制。你可以创建任意多个文档站点。它们都会列在侧边栏和应用中的“文档站点”部分，在那里你可以更改设置和自定义选项。你可以在 GitBook 应用中控制文档站点的所有设置和选项。你站点上的内容来自你 GitBook 组织中的空间。当你创建新的文档站点时，可以新建一个空间，或者链接一个已有空间。一个文档站点可以包含一个空间，也可以包含多个不同内容的空间——包括翻译版本和之前的产品版本。 ## 编辑内容 GitBook 的可视化编辑器让你可以使用所见即所得（WYSIWYG）界面向空间中添加内容。 ### 页面页面是你添加、编辑和嵌入内容的地方。页面始终位于某个空间中，而且你可以根据需要向空间添加任意多个页面。你空间中的页面会显示在编辑器左侧的目录中。在这里，你可以添加新页面、创建页面组，并将页面嵌套在其他页面中以创建子页面。 {% hint style="info" %} #### 看不到如何编辑或添加页面？如果你的站点已发布，在你对空间内容做出任何更改之前，需要先创建一个变更请求。 [请在下方阅读有关变更请求的内容](#change-requests). {% endhint %} ### 块 GitBook 是一个基于块的编辑器。这意味着你可以在页面中添加不同类型的块——从标准文本和图片到更高级的交互式块。你的页面可以包含你想要的任何块组合，而且页面上的块数量没有限制。基于块的编辑方式让你可以通过拖放轻松重组内容，或者在现有内容中间添加新的块。你可以使用编辑器界面创建新块，也可以使用 Markdown 创建并格式化块。在 GitBook 的“块”部分了解你可以使用的所有块 [位于“块”部分](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/creating-content/blocks). #### Markdown 编辑 GitBook 的编辑器允许你使用 Markdown 创建和格式化内容块。 Markdown 是一种广泛使用的标记语法，以简洁而闻名。GitBook 支持它作为一种便于键盘操作的方式来编写丰富且结构化的文本——GitBook 的所有块都可以使用 Markdown 语法编写。 {% hint style="info" %} 你可以通过访问以下内容来进一步了解 Markdown 本身 [CommonMark](https://commonmark.org/help/). {% endhint %} ### Git 同步 Git Sync 允许团队将 GitHub 或 GitLab 仓库与 GitBook 同步，并将 Markdown 文件转化为美观、易用的文档。设置完成后，它会在 GitBook 应用和你的代码库之间保持所有内容同步。 Git Sync 是双向的，因此你在 GitBook 可视化编辑器中所做的更改会自动同步——GitHub 或 GitLab 上的任何提交也是如此。这使开发者可以直接从 GitHub 或 GitLab 提交，而其他团队成员可以直接在 GitBook 中编辑并对更改留下反馈。 Git Sync 还解锁了 GitBook 文档中的许多其他实用工作流，例如批量更改、lint 检查等。了解更多，请参阅 [我们的 Git Sync 部分](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/getting-started/git-sync). ## 编辑流程 ### 变更请求变更请求是你主内容的一个 [**分支**](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) ，可用于进行并发编辑，同时保留你的版本历史。对于任何使用 GitHub 拉取请求或 GitLab 合并请求的人来说，这种体验都很熟悉。如果你想编辑已发布文档站点中的内容，首先需要在你的空间中打开一个变更请求。在变更请求中，你可以在空间里添加、编辑和删除内容，然后请求团队审核，并将你的更改合并到主内容中，以更新你已发布的文档站点。 {% hint style="info" %} #### 分支简述打开变更请求会在那个特定时点创建一份内容副本，有时也称为“分支”。在你选择合并变更请求之前，所做的任何更改都不会出现在主内容中。分支的优势在于，你的队友可以与你同时创建、编辑和合并各自的变更请求，而不会互相干扰。如果有人编辑了与你相同的内容，GitBook 会在你合并之前引导你解决任何冲突。 {% endhint %} #### 审核审核有助于加强监督，并提升文档的质量和准确性。在合并并让更改在你的文档站点上线之前，你可以为变更请求申请审核。为变更请求添加标题和描述可以为审核者提供一些上下文。审核者可以查看变更请求的差异，突出显示变更请求中所有新增、修改或删除的内容。他们也可以使用内置评论功能直接在页面上留下反馈——然后批准你的变更请求，或者要求继续修改。 #### 合并合并变更请求会将变更请求中的所有内容添加到主内容分支中——这些更改也会在你的文档站点上正式生效。当你合并变更请求时，还会在空间的版本历史中创建一个新版本。 ## 发布文档当你将内容发布为 [文档站点](#docs-site)时，你可以向站点添加更多内容、更改受众，并自定义其外观、风格和其他设置。 ### 构建你的文档站点结构如果你想向站点添加额外内容，可以使用两种选项，每一种都针对不同的使用场景而设计：站点分区和变体。 #### 站点分区站点分区的设计目的是让你可以向 **单个文档站点添加多种不同类型的文档**。例如，你可以使用一个文档站点来承载产品文档、API 参考、帮助中心和更新日志——就像我们在这个文档站点上所做的那样。当你添加新的站点分区时，你会在站点顶部构建导航栏，每个分区都会在导航栏中拥有自己的入口。你还可以将站点分区分组，以在导航栏中创建下拉菜单——非常适合为站点分区增加层级结构。 #### 变体变体的设计目的是让你可以向 **单个文档站点添加同一份文档的多个版本**。例如，你可能希望将整套文档本地化为多种语言，或者为尚未更新的用户记录产品的旧版本。最终用户可以使用站点左侧目录顶部的语言选择器或变体选择器，在这些变体之间切换。

A screenshot of the Roboflow Documentation site, with a navigation bar along the top and an open drop-down menu at the top of the table of contents showing different language variants for the site. — 站点分区会在站点顶部创建导航栏，而用户可以使用目录中的菜单在各个变体之间切换。

### 站点受众你可以选择在发布文档时谁能看到它。新站点的默认设置是公开发布，并可被搜索引擎索引。不过，如果你希望对谁可以访问你的站点有更多控制，可以选择使用以下方式限制受众 **共享链接** 或 **已认证访问**. 通过共享链接，你可以通过创建一个私密链接并直接分享给客户或合作伙伴，无需邀请他们加入你的组织，就能私下分享内容。任何拥有该链接的人都可以访问你的站点。如果你想要更进一步的控制，已认证访问允许你在发布内容的同时，要求任何想要查看内容的访客进行身份验证。启用后，GitBook 会让你的身份验证提供商来处理谁有权访问内容。这非常适合私密内容，或发布仅应由团队成员访问的内部知识库。你还可以使用一种称为自适应内容的功能来控制谁能看到单独的页面或块。设置完成后，它会根据你指定的用户属性显示或隐藏内容。了解更多，请参阅 [自适应内容页面](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/zhan-dian-fang-wen/adaptive-content). ### 站点自定义 GitBook 为文档站点提供内置的自定义选项，帮助你使文档的外观和风格与你的产品或品牌保持一致。即使你不应用任何自定义设置，文档本身也会看起来很棒。但你可以自定义徽标、图标和颜色，添加自定义字体，或者从一些内置主题中选择，让你的文档看起来和你的产品一样出色。

An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations — 你可以使用自己的徽标、颜色、字体、图片等更多内容来定制文档，使其与你的品牌相匹配。

### SEO 和 AI 优化在 GitBook 中发布的文档会自动针对搜索引擎优化（SEO）和 ChatGPT、Claude、Google AI Overview 等 AI 系统进行优化（GEO）。这些都在后端处理，因此你只需编写包含你想要定位的关键词和术语的内容即可。页面会从每页的标题和描述中提取元数据，并且你的内容会被格式化为响应式。GitBook 会根据你的目录自动创建站点地图，页面则通过我们的全球 CDN 缓存和提供，以提升性能。所有这些都有助于你的文档在搜索引擎中获得更高排名。同样，GitBook 也会按照不断演进的行业标准，为 AI 工具进行优化。 GitBook 会自动为每个页面创建 .md 版本，这使大型语言模型（LLM）更容易解析。我们还会为每个已发布站点自动暴露一个模型上下文协议（MCP）服务器，为 AI 工具提供一种结构化方式来发现并检索你的文档资源——无需抓取。此外，你的网站还会生成 `llms.txt` 并 `llms-full.txt` 专为 AI 摄取而设计。 ## 团队管理 ### 组织 GitBook 组织包含某个公司所有的内容和文档站点。使用同一个账户，你可以加入一个或多个组织，并通过 GitBook 应用左上角的下拉菜单在它们之间切换。 ### 成员成员是你组织中的个人用户。一个组织中可以拥有任意数量的成员，每个成员都可以根据其具体访问需求获得相应权限。 #### 权限权限让你决定组织成员的访问级别。当成员加入你的组织时，你会为他们分配一个角色——例如编辑者或查看者。这些角色定义了他们对你组织内所有内容的权限。但你也可以在内容级别覆盖这些权限。例如： * 你可以授予某个拥有查看者角色的人对某一特定内容的编辑权限 * 你可以限制对特定机密或私密内容的访问，并且只向你组织中的某些成员授予访问权限。请在以下页面阅读更多 [权限与继承页面](https://gitbook-v2-5hpihs24d-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/collaboration/member-management/permissions-and-inheritance).