> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/can-kao/concepts.md). # 核心概念
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 的可视化编辑器让你可以使用所见即所得（WYSIWYG）界面向部分中添加内容。 编辑可在台式机和笔记本设备上进行。你可以在智能手机上查看你的组织和内容，但编辑需要台式机或笔记本电脑。 ### 页面 页面是你添加、编辑和嵌入内容的地方。页面始终位于某个部分内，你可以根据需要向一个部分添加任意多的页面。 你所在部分中的页面会显示在编辑器左侧的目录中。在这里，你可以添加新页面、创建页面组，并将页面嵌套到其他页面中以创建子页面。 {% hint style="info" %} #### 不知道如何编辑或添加页面？ 如果你的网站已发布，在对某个部分的内容进行任何更改之前，你需要先创建一个变更请求。 [请在下方阅读有关变更请求的说明](#change-requests). {% endhint %} ### 区块 GitBook 是一个基于区块的编辑器。这意味着你可以向页面添加不同类型的区块——从标准文本和图片到更高级的交互式区块。你的页面可以包含任意组合的区块，而且页面上的区块数量没有限制。 基于区块的编辑让你可以通过拖放轻松重组内容，或在现有内容中间添加新区块。你可以使用编辑器界面创建新区块，也可以使用 Markdown 创建和格式化区块。 探索你在 GitBook 中可以使用的所有区块 [在“区块”部分](/docs/documentation/zh/chuang-jian-nei-rong/blocks.md). #### Markdown 编辑 GitBook 的编辑器允许你使用 Markdown 创建和格式化内容区块。 Markdown 是一种流行的标记语法，以简单著称。GitBook 支持它作为一种更适合键盘输入的方式来编写富文本和结构化文本——GitBook 的所有区块都可以使用 Markdown 语法编写。 {% hint style="info" %} 你可以通过访问以下内容来进一步了解 Markdown 本身 [CommonMark](https://commonmark.org/help/). {% endhint %} ### Git Sync Git Sync 允许团队将 GitHub 或 GitLab 仓库与 GitBook 同步，并将 Markdown 文件转化为美观、易用的文档。设置完成后，它会在 GitBook 应用和你的代码库之间保持所有内容同步。 Git Sync 是双向的，因此你在 GitBook 可视化编辑器中所做的更改会自动同步——GitHub 或 GitLab 上提交的任何变更也是如此。这使开发者可以直接从 GitHub 或 GitLab 提交，而其他团队成员则可以在 GitBook 中直接编辑并对变更留下反馈。 Git Sync 还为你的 GitBook 文档解锁了许多其他有用的工作流，例如批量更改、代码检查等等。了解更多请见 [我们的 Git Sync 部分](/docs/documentation/zh/wen-dang-ji-dai-ma/git-sync.md). ## 编辑流程 ### 变更请求 变更请求是你的主内容的一个 [**分支**](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) ，你可以使用它进行并发编辑，同时保留版本历史。对于任何使用 GitHub 中拉取请求或 GitLab 中合并请求的人来说，这都会很熟悉。 如果你想编辑已发布文档站点上的内容，你首先需要在你的部分中打开一个变更请求。 在变更请求中，你可以在某个部分中添加、编辑和删除内容，然后请求团队审阅，并将你的更改合并到主内容中，以更新已发布的文档站点。 {% hint style="info" %} #### 分支简述 打开变更请求会在那个特定时间点创建你内容的副本，有时也称为“分支”。在你选择合并变更请求之前，所做的任何更改都不会出现在主内容中。 分支的优点在于，你的队友可以与你同时创建、编辑和合并他们自己的变更请求，而不会互相干扰。如果有人编辑了与你相同的内容，GitBook 会在你合并之前引导你解决任何冲突。 {% endhint %} #### 审阅 审阅有助于加强监督，并帮助提升文档的质量和准确性。 在合并并让更改生效到你的文档站点之前，你可以先对变更请求发起审阅。为你的变更请求添加标题和描述，可以为审阅者提供一些上下文。 审阅者可以查看变更请求的差异内容，其中会突出显示变更请求中所有新增、修改或删除的内容。他们也可以直接使用内置评论功能在页面上留下反馈——然后批准你的变更请求，或者要求进行更多修改。 #### 合并 合并变更请求会将变更请求中的所有内容添加到内容主分支中——这些更改也会同步上线到你的文档站点。 当你合并变更请求时，它也会在该部分的版本历史中创建一个新版本。 ## 发布文档 当你将内容发布为 [文档站点](#docs-site)时，你可以向网站添加更多内容、更改受众，并自定义其外观、体验和其他设置。 ### 组织你的文档站点结构 如果你想向网站添加额外内容，有两种可用选项，每种都针对不同的使用场景：部分和变体。 #### 站点结构中的部分 部分让你可以向单一文档站点添加 **多种不同类型的文档**。例如，你可以使用一个文档站点来托管产品文档、API 参考、帮助中心和更新日志——就像我们在这个文档站点中所做的那样。 当你添加新部分时，你就在构建网站顶部的导航栏，每个部分都会在导航栏上拥有自己的条目。你也可以将部分放在一个 [分组](#collection) 中，从而在导航栏中创建一个下拉菜单——非常适合为你的网站增加层级结构。 #### 变体 变体旨在让你向单一文档站点添加 **同一文档的多个版本**。例如，你可能希望将整套文档本地化为多种语言，或者为尚未更新的用户记录产品的旧版本。 你的最终用户可以在文档站点上使用语言选择器或左侧目录顶部的变体选择器，在这些变体之间切换。
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 会让你的身份验证提供商处理谁可以访问这些内容。这非常适合私密内容，或者发布仅团队成员可访问的内部知识库。 你还可以使用一种称为自适应内容的功能来控制谁能看到单个页面或区块。设置完成后，它会根据你指定的用户属性显示或隐藏内容。更多内容请阅读 [自适应内容页面](/docs/documentation/zh/fa-bu/adaptive-content.md). ### 站点自定义 GitBook 为文档站点提供内置的自定义选项，帮助你将文档的外观和体验与产品或品牌保持一致。 即使你不应用任何自定义，你的文档本身看起来也已经很棒。但你也可以自定义徽标、图标和颜色，添加自定义字体，或从一些内置主题中选择，让你的文档和产品一样出色。
An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations

你可以使用自己的徽标、颜色、字体、图片等等，自定义文档以匹配你的品牌。

### SEO 和 AI 优化 在 GitBook 中发布的文档会自动针对搜索引擎优化（SEO）以及 ChatGPT、Claude 和 Google AI Overview（GEO）等 AI 系统进行优化。这些都在后端处理，所以你只需要编写包含你想要定位的关键词和术语的内容即可。 页面会从每个页面的标题和描述中提取元数据，且你的内容会被格式化为响应式。GitBook 会根据你的目录自动创建站点地图，页面则通过我们的全球 CDN 缓存和提供，以提升性能。所有这些都有助于你的文档在搜索引擎中获得更高排名。 同样，GitBook 也会根据不断快速演进的行业标准为 AI 工具进行优化。 GitBook 会自动为每个页面创建 .md 版本，这使大语言模型（LLMs）更容易解析。我们还会为每个已发布站点自动公开一个模型上下文协议（MCP）服务器，为 AI 工具提供一种结构化方式来发现并检索你的文档作为资源——无需抓取。此外，你的网站还会生成 `llms.txt` 并 `llms-full.txt` 为 AI 摄取而设计。 ## 团队管理 ### 组织 GitBook 组织包含某一公司的所有内容和文档站点。使用同一个账户，你可以成为一个或多个组织的成员，并通过侧边栏顶部的组织菜单在它们之间切换。 ### 成员 成员是你组织中的个人用户。一个组织中可以拥有任意多的成员，每个成员都有适合其具体访问需求的权限。 #### 权限 权限让你决定组织成员的访问级别。当成员加入你的组织时，你会为他们分配一个角色——例如编辑者或查看者。这些角色定义了他们对你组织所有内容的权限。但你也可以在内容级别覆盖这些权限。例如： * 你可以为具有查看者角色的人授予某一特定内容的编辑权限 * 你可以限制对特定机密或私密内容的访问，并且只向你组织中的某些成员授予访问权限。 更多内容请参见 [“权限和继承”页面](/docs/documentation/zh/xie-zuo/member-management/permissions-and-inheritance.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://gitbook.com/docs/documentation/zh/can-kao/concepts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.