> 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/gitbook-ui.md).

# GitBook 界面

了解如何浏览 GitBook

GitBook 围绕文档站点组织内容。您可以从组织 **主页**开始，打开站点以处理其内容，并在各个分区中编辑页面。本页将介绍界面的各个部分。

### 首页

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-e66d024d11d1bb818700485609f389ddf21d2949%2F25_12_10_gitbook_ui_1.png?alt=media" alt=""><figcaption><p>你的组织首页可让你访问站点、内容和组织控制项。</p></figcaption></figure></div>

打开 GitBook 后，您会进入组织 **主页**：在一个地方查看组织中的所有文档站点。在这里，您可以打开站点、创建新站点，或调整组织范围的设置。主页包含：

* **切换器**\
  无论身处何处，都可以通过侧边栏顶部的切换器返回 **主页** 。如果您加入了多个组织，可以在此查看并切换组织，也可以创建新组织。
* **通知**\
  有人在评论或对话中提及您，或者您正在处理的分区中有重要动态时，您会收到 [通知](https://gitbook.com/docs/documentation/zh/collaborate/notifications.md) ，了解最新动态。
* **提问或搜索**\
  由 [GitBook Agent](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content/gitbook-ai.md)提供支持，您可以用自然语言提问，也可以搜索组织中的站点和内容。
* **站点列表**\
  查看组织中的所有文档站点。点击某个站点即可打开。
* **内容**\
  打开 [所有内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/all-content.md) 页面，您可以浏览、筛选和搜索所有站点中的内容，以及尚未归属任何站点的内容。
* **空间**\
  尚未归属任何站点的空间会列在侧边栏底部。
* **设置**\
  [组织设置](https://gitbook.com/docs/documentation/zh/zhang-hu-yu-ji-fei/organization-settings.md) 和 [账户设置](https://gitbook.com/docs/documentation/zh/zhang-hu-yu-ji-fei/account-settings.md) 共用一个专属页面。设置按以下类别分组： **账户** 和 **组织**.

  **账户** 包括 **常规**, **通知**, **组织**和 **开发者工具**. **组织** 包括 **常规**, **成员**, **合并规则**, **GitBook Agent**, **集成**, **OpenAPI**, **翻译**, **邀请链接**, **团队**, **访问权限**和 **账单**。点击 **返回应用** 以返回您的工作区。
* **样式指南**\
  查看组织中的所有 [样式指南](https://gitbook.com/docs/documentation/zh/manage-your-site/site-structure.md) 以及使用这些指南的网站。
* **回收站**\
  已删除的部分会显示在 **回收站**。你可以在七天内恢复这些内容；之后它们将被永久删除。

### 站点侧边栏

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

* **网站页眉**\
  网站名称和发布状态，以及 **预览** 和 **发布** 按钮。
* **网站工具**\
  **概览**, **变更请求**, **网站结构**, **自定义**, **扩展**和 **设置**，以及 **Git 同步** 和 **分流处理** （如适用）。每项都会在主视图中打开。
* **分析**\
  [**流量**](https://gitbook.com/docs/documentation/zh/analytics/insights/traffic.md), [**智能体和 MCP**](https://gitbook.com/docs/documentation/zh/analytics/insights/agents-and-mcp.md)和 [**AI 助手**](https://gitbook.com/docs/documentation/zh/analytics/insights/ai-insights.md) 报告。
* **改进**\
  [**样式指南**](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md), [**内容缺口**](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md)和 [**失效链接**](https://gitbook.com/docs/documentation/zh/analytics/broken-links.md).
* **内容**\
  网站的 [部分](https://gitbook.com/docs/documentation/zh/manage-your-site/site-structure/site-sections.md) 和分组，按发布顺序排列。点击某个部分即可编辑。

  此树为只读。请在 [结构编辑器](https://gitbook.com/docs/documentation/zh/manage-your-site/site-structure.md)中重新组织。使用搜索、编辑和 **+** 图标， **内容** 页眉中的图标可查找、重命名和添加部分。

### 目录 <a href="#the-table-of-contents" id="the-table-of-contents"></a>

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-9958c6ae27468a601cb917a1ccc2ca6530c2a592%2F25_12_10_gitbook_ui_2.png?alt=media" alt=""><figcaption><p>目录列出你所选部分中的所有页面和链接。</p></figcaption></figure></div>

默认情况下，目录会列出 [页面、链接和页面组](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page.md#organizing-your-content) 在所选分区中。它位于侧边栏右侧。

你还可以管理 [可重复使用的内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/reusable-content.md) 和 [文件](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files.md) 。

在目录中的 **页面** 标签页中，你可以：

* 创建新 [页面](#pages) 和子页面。
* 创建 [页面组](#groups).
* 添加 [外部链接](#external-links).
* 打开 [操作菜单](#the-actions-menu) <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt=""></picture> 以管理单个页面。

在 **资源库** 标签页中，你可以：

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

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

{% embed url="<https://youtu.be/gg-VZP2wl-I>" %}

若要专注于页面内容，请将鼠标悬停在目录旁边，然后点击 **隐藏** <picture><source srcset="broken://files/t7RZoZXBNdmA75mANdIQ" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-03252fcbda089b385f299f82de6d16069c9e8291%2F25_10_08_panel_left_1.svg?alt=media" alt="The Hide button icon in GitBook"></picture>。若要再次显示目录，请将鼠标悬停在页面边缘附近，然后点击 **显示** <picture><source srcset="broken://files/Vxv06rO6ZJQJWLfW9YHZ" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-c88cbe17422cec2ecd176b08d16e3413aec30c3c%2F25_10_08_panel_right_1.svg?alt=media" alt="The Show button icon in GitBook"></picture>.

### 部分页眉 <a href="#space-header" id="space-header"></a>

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a0a82ba04e7bf18bcd5ddd07490f72ec18f9346c%2F25_12_10_gitbook_ui_3.png?alt=media" alt=""><figcaption><p>部分页眉位于编辑器顶部，并提供适用于整个部分的选项。</p></figcaption></figure></div>

分区标题栏显示有关当前所查看分区的信息。你可以在此查看评论和历史记录、配置 [GitHub 或 GitLab 同步](https://gitbook.com/docs/documentation/zh/docs-as-code/git-sync.md)等。

{% hint style="info" %}
**分区标题栏会根据需要灵活调整**，并会随当前所在的分区和模式而变化。

例如，如果你正在编辑 [变更请求](https://gitbook.com/docs/documentation/zh/collaborate/change-requests.md)，你会看到该变更请求的概览，以及打开编辑器、查看变更和合并变更请求等选项。

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

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-8e7e90e06dbbe1305876f0cfb0830d4acbc5e04c%2F25_12_10_gitbook_ui_4.png?alt=media" alt=""><figcaption><p>变更请求中的部分页眉。</p></figcaption></figure></div>

部分页眉包括：

* **分区表情符号或图标**\
  为分区选择表情符号或图标，以便在侧边栏中识别它。
* **分区名称**\
  此名称会显示在侧边栏和已发布的网站上。
* **分区的面包屑导航**\
  该分区所属的网站，以及（如有）所属的组。
* **操作菜单**\
  提供适用于分区的操作。与 [页面操作](#the-actions-menu)类似，可用操作会因编辑模式而异。
* **概览**\
  在变更请求中，查看其标题、说明、参与者、审核者、变更和评论。
* **编辑器视图**\
  使用 GitBook 的区块式编辑器编辑内容。
* **变更视图**\
  此视图 [突出显示变更](https://gitbook.com/docs/documentation/zh/collaborate/change-requests.md#diff-mode) 在变更请求中使用差异视图查看变更。合并前请先检查变更。
* **预览**\
  合并变更请求前预览内容。
* **协作者**\
  查看正在阅读此分区页面的人员头像。点击头像即可打开他们正在查看的页面。
* **Git 同步配置**\
  配置 GitHub 和 GitLab [同步](https://gitbook.com/docs/documentation/zh/docs-as-code/git-sync.md) 此分区。
* **“共享”菜单**\
  发布并共享分区，或邀请他人协作。
* **变量**\
  为此分区创建可重复使用的 [变量](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions.md) 。
* **GitBook Agent**\
  与以下对象协作处理分区变更： [GitBook Agent](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/overview.md).
* **评论**\
  查看关于分区内容的 [评论和讨论](https://gitbook.com/docs/documentation/zh/collaborate/comments.md) 。
* **变更请求**\
  创建、更新和删除 [变更请求](https://gitbook.com/docs/documentation/zh/collaborate/change-requests.md).
* **分区历史记录**\
  查看 [此分区或变更请求的](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/version-control.md) 版本历史记录。
* **“编辑”按钮**\
  如果分区已发布，或者 [实时编辑](https://gitbook.com/docs/documentation/zh/collaborate/live-edits.md) 已锁定， **编辑** 会创建一个 [变更请求](https://gitbook.com/docs/documentation/zh/collaborate/change-requests.md).

### 站点工具 <a href="#site-headers" id="site-headers"></a>

在主视图中，点击站点侧边栏顶部即可打开站点工具。站点页眉中始终显示 **预览** 和 **发布**.

* **概览**\
  站点基本信息，包括其 URL、发布状态、受众、内容和顶层分析数据。站点上线后， **概览** 会链接到该站点。
* **变更请求**\
  站点各分区中的变更请求。
* **站点结构**\
  使用 [结构编辑器](https://gitbook.com/docs/documentation/zh/manage-your-site/site-structure.md) 添加、重新排序、发布和移除分区及分组。
* **设置**\
  [站点设置](https://gitbook.com/docs/documentation/zh/manage-your-site/site-settings.md) 包括 **常规**, **成员**, **智能体**, **受众**, **域名和 URL**, **重定向**和 **套餐**.
* **自定义**\
  [自定义你的站点](https://gitbook.com/docs/documentation/zh/manage-your-site/customization.md) 使用 **主题**, **布局**, **AI 助手**和 **配置** 选项。
* **扩展**\
  **连接**, **渠道**, **文档嵌入**, **MCP 访问**和 [**集成**](https://gitbook.com/docs/documentation/zh/manage-your-site/install-an-integration.md).

在 **分析**中， [站点分析](https://gitbook.com/docs/documentation/zh/analytics/insights.md) 报告会展示用户和智能体如何阅读你的站点： **流量**, **智能体和 MCP**和 **AI 助手**.

在 **改进**中，GitBook 会检查你已发布的文档，并帮助你修复发现的问题：

* **风格指南**\
  你的站点 [风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md) 定义了写作规则和规范。GitBook Agent 在撰写、编辑或审阅内容时会遵循这些规则。
* **内容缺口**\
  [内容缺口](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md) 列出文档尚未解答的问题。
* **失效链接**\
  [失效链接](https://gitbook.com/docs/documentation/zh/analytics/broken-links.md) 查找返回 404 的 URL，并建议重定向。

### 内容编辑器

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-3427553265e3cf57837bbc1fd3f0e4dcbdb52189%2F25_12_10_gitbook_ui_5.png?alt=media" alt=""><figcaption><p>在 GitBook 编辑器中撰写内容并添加块。</p></figcaption></figure></div>

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

插入 [内容块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks.md)，编写 [Markdown](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown.md), [嵌入内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url.md)，并与 [GitBook Agent](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/overview.md).

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

### 页面标题和描述 <a href="#page-title" id="page-title"></a>

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

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

{% hint style="info" %}
要更改页面 URL 中的别名，请打开页面的 [操作菜单](#the-actions-menu) 并点击 **编辑标题和别名**.
{% endhint %}

### 页面操作菜单 <a href="#the-actions-menu" id="the-actions-menu"></a>

页面的 **操作菜单** <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt="The Actions menu icon in GitBook"></picture> 可用于复制、重命名或删除页面。

在目录中，将鼠标悬停在页面上，然后点击 <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt="The Actions menu icon in GitBook"></picture> 图标。你也可以点击页面标题旁边的图标。

{% hint style="info" %}
可用操作取决于你使用的是 [实时编辑](https://gitbook.com/docs/documentation/zh/collaborate/live-edits.md) 还是 [变更请求](https://gitbook.com/docs/documentation/zh/collaborate/change-requests.md).
{% endhint %}

### 页面选项 <a href="#page-options" id="page-options"></a>

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-66f9417ae7e11e684d268db426fb53244a018404%2F25_12_10_gitbook_ui_6.png?alt=media" alt=""><figcaption><p>「 <strong>页面选项</strong> 侧边栏提供文档和导航的自定义选项。</p></figcaption></figure></div>

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

从页面的 **页面选项** 打开 **操作菜单** <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt="The Actions menu icon in GitBook"></picture> ，然后选择 **选项**」。你也可以将鼠标悬停在页面标题上，然后点击 **页面选项**.

{% hint style="info" %}
某些更改，例如禁用目录，仅会显示在已发布的文档中。
{% endhint %}

### 页面大纲

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-fa0746ea5eabceefbbb081259fbfb498c1a2ce6f%2F25_12_10_gitbook_ui_7.png?alt=media" alt=""><figcaption><p>页面大纲显示 H1 和 H2 标题，让你能够快速跳转到单个页面中的特定部分。</p></figcaption></figure></div>

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

大纲列出页面上的 H1 和 H2 [标题](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading.md) 。

页面大纲也会显示在已发布的网站上。可在 [页面选项](#page-options) 侧边栏中切换显示或隐藏。

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


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/zh/can-kao/gitbook-ui.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
