GitBook 界面

了解如何浏览 GitBook

GitBook 围绕你的文档站点进行组织。你从你的组织开始 首页，打开一个站点来处理其内容，并在各个部分中编辑页面。本页将带你了解界面的每一部分。

首页

你的组织首页可让你访问站点、内容和组织控制项。

打开 GitBook 后，你会进入你的组织 首页：你组织中的所有文档站点都集中在一个地方。从这里你可以打开一个站点、创建新站点，或调整组织级设置。首页包含：

• 切换器 返回 首页 可通过侧边栏顶部的切换器从任何地方返回到。若你属于多个组织，可在此查看并在它们之间切换，或创建新组织。
• 通知 当你在评论或对话中被标记，或者你正在处理的某个部分有重要活动时，你会收到一个 通知 来显示最新动态。
• 询问或搜索 由……提供支持 GitBook 代理，你可以用自然语言提问，或在你的组织中的站点和内容中搜索。
• 站点列表 查看你组织中的每个文档站点。点击某个站点即可打开。
• 全部内容 如果你的组织中有不属于任何站点的内容，它会显示在一个 全部内容 部分中，与你的站点并列，以树状视图显示。如果每一条内容都属于某个站点，则此部分不会出现。
• 设置 组织设置 和 账户设置 共用一个专门页面。它按以下内容分组设置： 账号 和 组织.

  账号 包括 常规, 通知, 组织，以及 开发者工具. 组织 包括 常规, 成员, 合并规则, GitBook 代理, 集成, OpenAPI, 翻译, 邀请链接, 团队, 单点登录，以及 账单。点击 返回应用 以返回到你的工作。
• 风格指南 查看每个 风格指南 在你的组织中以及使用它的站点中。
• 回收站 已删除的部分会出现在 回收站。你可以在最多七天内恢复它们——之后它们将被永久删除。

站点侧边栏

打开站点后，侧边栏会替换为该站点的内容和工具：与访客在已发布站点上看到的结构相同。站点侧边栏包含：

• 站点页眉 你的站点名称和发布状态，以及 预览 和 发布 按钮。
• 站点工具 概览, 变更请求, 站点结构, 自定义, 扩展，以及 设置，以及 Git Sync 和 分诊 在适用的地方。每个都会在主视图中打开。
• 分析 流量, Agents 与 MCP，以及 AI 助手 报告。
• 改进 写作风格指南, 内容缺口，以及 失效链接.
• 内容 你的站点的 章节 以及分组，按发布顺序排列。点击某个部分即可编辑。

  该树状结构为只读。请在 结构编辑器中重新组织它。使用搜索、编辑和 + 图标以及 内容 页眉中的图标来查找、重命名和添加部分。

目录

目录列出你所选部分中的所有页面和链接。

默认情况下，目录列出 页面、链接和页面组 在你所选的部分中。它位于侧边栏右侧。

你还可以管理 可复用内容 和 文件 ，用于该部分。

在 页面 目录中的选项卡里，你可以：

• 创建新的 页面 和子页面。
• 创建 页面组.
• 添加 外部链接.
• 访问 操作菜单 ，用于单个页面。

在 资源库 选项卡中，你可以：

• 查看并搜索该部分中的可复用内容、变量、图片和文件。
• 查看并插入来自其他部分的可复用内容。
• 创建或导入新的资源库项。
• 将资源库项拖放到页面上。
• 双击资源库项可重命名。
• 预览图片。
• 管理并下载图片和文件。

这里有一个简短视频，展示你可以如何使用目录，尤其是资源库选项卡：

若要聚焦页面内容，将鼠标悬停在目录旁边并点击 隐藏 。要再次显示它，将鼠标悬停在页面边缘附近并点击 显示 .

部分页眉

部分页眉位于编辑器顶部，并提供适用于整个部分的选项。

部分页眉包含你当前正在查看的部分的信息。它可让你查看评论和历史记录，配置 GitHub 或 GitLab 同步，等等。

部分页眉具有适应性，会根据你当前所在的部分和模式而变化。

例如，如果你正在编辑一个 变更请求，你会看到该变更请求的概览，以及打开编辑器、查看更改和合并变更请求的选项。

如果你正在查看只读部分，则需要打开一个新的变更请求来编辑页面，因为实时编辑已被锁定。

变更请求中的部分页眉。

部分页眉包括：

• 部分的表情符号或图标 为你的部分选择一个表情符号或图标，以便在侧边栏中识别它。
• 部分名称 该名称会显示在侧边栏和已发布站点上。
• 该部分的面包屑导航 该部分所在的站点，以及所属分组（如果有）。
• 操作菜单 为你的部分提供操作。类似于 页面操作，可用操作会因编辑模式而异。
• 概览 在变更请求中，查看其标题、描述、参与者、审阅者、更改和评论。
• 编辑器视图 使用 GitBook 基于块的编辑器编辑内容。
• 更改视图 此视图 突出显示更改 在变更请求中使用差异视图。合并前审阅更改。
• 预览 在合并变更请求前预览内容。
• 协作者 查看正在阅读该部分页面的人的头像。点击头像可打开他们正在查看的页面。
• Git 同步配置 配置 GitHub 和 GitLab 同步 ，用于该部分。
• 分享菜单 发布并分享你的部分，或邀请他人协作。
• 变量 创建可复用的 变量 ，用于该部分。
• GitBook 代理 就部分更改进行协作，借助 GitBook 代理.
• 评论 查看 评论和讨论 关于部分内容。
• 变更请求 创建、更新和删除 变更请求.
• 部分历史 查看 版本历史 ，用于该部分或变更请求。
• 编辑按钮 如果某个部分已发布或者 实时编辑 被锁定， 编辑 会创建一个 变更请求.

站点工具

站点工具可从主视图中站点侧边栏顶部打开。站点页眉会保留 预览 和 发布.

• 概览 关键站点信息，包括其 URL、发布状态、受众、内容和顶层洞察。站点上线后， 概览 会链接到它。
• 变更请求 你站点各部分中的变更请求。
• 站点结构 使用 结构编辑器 来添加、重新排序、发布和移除部分与分组。
• 设置 站点设置 包括 常规, 成员, Agents, 受众, 域名和 URL, 重定向，以及 套餐.
• 自定义 自定义你的站点 使用 主题, 布局, AI 助手，以及 配置 选项。
• 扩展 连接, 渠道, 文档嵌入, MCP 访问，以及 集成.

下方 分析，该 站点分析 报告显示人和代理如何阅读您的网站： 流量, Agents 与 MCP，以及 AI 助手.

下方 改进，GitBook 会检查您已发布的文档，并帮助您修复发现的问题：

• 写作风格指南 你的站点的 风格指南 定义写作规则和约定。GitBook Agent 在编写、编辑或审阅内容时会遵循它。
• 内容缺口 内容缺口 列出您的文档未回答的问题。
• 失效链接 失效链接 查找返回 404 的 URL，并建议重定向。

内容编辑器

在 GitBook 编辑器中撰写内容并添加块。

编辑器是你部分的主要区域。编写并插入内容，然后与团队实时协作。

插入 内容块，编写 Markdown, 嵌入内容，并与 GitBook 代理.

你还可以对块发表评论并标记队友。

页面标题和描述

在每个页面顶部，设置标题、添加可选表情符号并编写描述。标题会显示在目录中，并构成已发布 URL 的 slug。

你的页面描述最多可包含 200 个字符。它会作为搜索引擎中的预览文本显示。

若要更改页面 URL slug，请打开该页面的 操作菜单 并点击 编辑标题和 slug.

页面操作菜单

该页面的 操作菜单 可让你复制、重命名或删除页面。

在目录中，将鼠标悬停在某个页面上并点击该 图标。你也可以点击页面标题旁边的图标。

可用操作取决于你是否使用 实时编辑 或 变更请求.

页面选项

该 页面选项 侧边面板为你的文档和导航提供自定义选项。

使用页面选项来自定义文档布局和导航。页面选项仅在编辑时可用。

打开 页面选项 从页面的 操作菜单 通过选择 选项。你也可以将鼠标悬停在页面标题上并点击 页面选项.

某些更改，例如禁用目录，仅会显示在已发布的文档中。

页面大纲

页面大纲显示 H1 和 H2 标题，让你能够快速跳转到单个页面中的特定部分。

页面大纲位于编辑器右侧。它可让你跳转到页面部分。

大纲列出 H1 和 H2 标题 在页面上的。

页面大纲也会显示在你的已发布站点上。可在 页面选项 侧边面板中切换它。

如果右侧列不可见，你的浏览器窗口可能宽度不足 1430 像素。请使用至少 1430 像素宽的窗口来查看和使用页面大纲。