概念
学习基础知识，以便为您的用户创建和发布出色的文档
组织内容
空间
空间是一个项目，让你在其中处理一组相关页面。在空间内，你可以撰写内容、通过分组和子页面组织页面、安装集成等。
当你想要发布一个空间时，可以将其添加到文档站点。你可以在一个文档站点中添加任意多个空间。因此在构建内容时，你可以为产品文档、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 文档中解锁许多其他有用的工作流程，例如批量更改、代码检查（linting）等。详见 我们的 Git 同步部分.
编辑流程
变更请求
变更请求是一个 分支 你的主内容的分支，可用于进行并行编辑，同时保持版本历史。对于使用 GitHub 的拉取请求或 GitLab 的合并请求的任何人来说，这会感觉很熟悉。
如果你想编辑已发布文档站点上的内容，首先需要在你的空间中打开一个变更请求。
在变更请求中，你可以在空间中添加、编辑和删除内容，然后向团队请求审查，并将更改合并到主内容中以更新已发布的文档站点。
分支简介
打开变更请求会在特定时刻创建你内容的副本，有时称为“分支”。你所做的任何更改在你选择合并变更请求之前都不会出现在主内容中。
分支的好处在于，你的队友可以在与你同时创建、编辑和合并他们自己的变更请求而不会互相冲突。如果有人编辑了与你相同的内容，GitBook 会在你合并之前引导你解决任何冲突。
审核
审核促进监督并有助于提高文档的质量与准确性。
在合并并将更改在文档站点上生效之前，你可以在变更请求上请求审核。为变更请求添加标题和描述可为审阅者提供一些背景信息。
审阅者可以查看变更请求的差异（diff），其中会突出显示变更请求中所有新增、修改或删除的内容。他们还可以使用内置的评论功能直接在页面上留下反馈——然后批准你的变更请求，或要求进行更多更改。
合并
合并变更请求会将变更请求中的所有内容添加到主分支内容中——这些更改也会在你的文档站点上生效。
当你合并变更请求时，它还会在该空间的版本历史中创建一个新版本。
发布文档
当你将内容发布为 文档站点时，你可以向站点添加更多内容、更改受众，并自定义其外观、感觉和其他设置。
构建文档站点的结构
如果你想向站点添加额外内容，有两种供你使用的选项，每种针对不同用例：站点部分和变体。
站点部分
站点部分用于让你向单一文档站点添加 多种不同类型的文档。例如，你可以使用单一文档站点来托管你的产品文档、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 应用左上角的下拉菜单在它们之间切换。
成员
成员是你组织中的单个用户。组织中可以有任意数量的成员，每个成员拥有适合其特定访问需求的权限。
权限
权限让你决定组织成员的访问级别。当成员加入你的组织时，你会为他们分配一个角色——例如编辑者或查看者。这些角色定义了他们对组织所有内容的权限。但你也可以在内容级别覆盖这些权限。例如：
你可以赋予具有查看者角色的人对某一特定内容的编辑访问权限
你可以限制对特定机密或私有内容的访问，并仅向组织中的某些成员授予访问权限。
在下文阅读更多内容 有关权限与继承的页面.
最后更新于
这有帮助吗？