> 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%2FMINl0qBtvGV3pt8G3bnZ%2FCleanShot%202025-12-10%20at%2010.02.40.png?alt=media&amp;token=57f3871d-67b0-432e-b646-8b5e5a073aaa" alt=""><figcaption><p>你的组织主页可让你访问站点、内容和组织控制项。</p></figcaption></figure></div>

当你打开 GitBook 时，你会进入你的组织 **主页**：你的组织中的每个文档站点都集中在一个地方。从这里你可以打开一个站点、创建新站点，或调整组织范围设置。主页包含：

* **切换器**\
  返回到 **主页** ，可使用侧边栏顶部的切换器从任何位置返回。如果你属于多个组织，可在这里查看并在它们之间切换，或者创建一个新组织。
* **通知**\
  当你在评论或对话中被提及，或你正在处理的部分有重要活动时，你会收到一个 [通知](/docs/documentation/zh/xie-zuo/notifications.md) ，向你显示最新动态。
* **提问或搜索**\
  由……驱动 [GitBook Agent](/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content/gitbook-ai.md)，可用自然语言提问，或搜索你组织中的站点和内容。
* **站点列表**\
  查看你组织中的每个文档站点。点击某个站点即可打开。
* **所有内容**\
  如果你的组织中有不属于任何站点的内容，它会显示在一个 **所有内容** 与你的站点并列的树状视图部分中。如果每一项内容都属于某个站点，则不会显示此部分。
* **设置**\
  [组织设置](/docs/documentation/zh/zhang-hu-yu-ji-fei/organization-settings.md) 以及 [账户设置](/docs/documentation/zh/zhang-hu-yu-ji-fei/account-settings.md) 共用一个专用页面。它按以下类别分组设置： **账户** 以及 **组织**.

  **账户** 包括 **常规**, **通知**, **组织**，以及 **开发者工具**. **组织** 包括 **常规**, **成员**, **合并规则**, **GitBook Agent**, **集成**, **OpenAPI**, **翻译**, **邀请链接**, **团队**, **单点登录**，以及 **计费**。点击 **返回应用** 返回你的工作。
* **样式指南**\
  查看每个 [样式指南](/docs/documentation/zh/guan-li-ni-de-zhan-dian/site-structure.md) 以及你组织中使用它的站点。
* **废纸篓**\
  已删除的部分会出现在 **废纸篓**中。你可以在七天内恢复它们——之后它们将被永久删除。

### 站点侧边栏

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

* **站点页眉**\
  你站点的名称和发布状态，以及 **预览** 以及 **发布** 按钮。
* **常规**\
  **概述**, **变更请求**, **网站结构**，以及 **设置**.
* **工具**\
  **风格指南**, **自定义**, **分析**，以及 **扩展**。每个都会在主视图中打开。
* **内容**\
  你站点的 [部分](/docs/documentation/zh/guan-li-ni-de-zhan-dian/site-structure/site-sections.md) 部分和分组，按发布顺序排列。点击某个部分即可编辑它。

  此树状结构为只读。请在 [结构编辑器](/docs/documentation/zh/guan-li-ni-de-zhan-dian/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%2FZYKSwnzcZOkqVA2xgRlX%2FCleanShot%202025-12-10%20at%2010.07.01.png?alt=media&amp;token=47cb70e3-4cee-4fdd-8247-28a04e75f92e" alt=""><figcaption><p>目录列出你所选部分中的所有页面和链接。</p></figcaption></figure></div>

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

你还可以管理 [可复用内容](/docs/documentation/zh/chuang-jian-nei-rong/reusable-content.md) 以及 [文件](/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files.md) ，用于该部分。

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

* 创建新的 [页面](#pages) 和子页面。
* 创建 [页面组](#groups).
* 添加 [外部链接](#external-links).
* 访问权限 [操作菜单](#the-actions-menu) <picture><source srcset="/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%2F89MTSo5XRpPMVr1T0rxS%2Factions.svg?alt=media&amp;token=2b5d001e-560a-4f29-8d22-de8163725ca1" alt=""></picture> ，用于单个页面。

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

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

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

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

要聚焦页面内容，请将鼠标悬停在目录旁并点击 **隐藏** <picture><source srcset="/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%2F0goJ97jfVBvH656kUK0d%2Fpanel%20left.svg?alt=media&amp;token=cb31d43b-804c-4c4f-b5bb-e71db0d03860" alt="The Hide button icon in GitBook"></picture>。要再次显示，请将鼠标悬停在页面边缘附近并点击 **显示** <picture><source srcset="/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%2FwOFmEqy96fMvDPjqjAED%2Fpanel%20right.svg?alt=media&amp;token=2f39279a-cd05-48a3-8985-d07ec08663ba" 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%2F2Z5NSb3mmbMRoWqONncm%2FCleanShot%202025-12-10%20at%2010.08.48.png?alt=media&amp;token=da8f53b3-d134-46e1-84d1-db3c1e1eb3cd" alt=""><figcaption><p>部分页眉位于编辑器顶部，并提供适用于整个部分的选项。</p></figcaption></figure></div>

部分页眉包含你当前查看的部分的信息。它让你可以查看评论和历史记录，配置 [GitHub 或 GitLab 同步](/docs/documentation/zh/wen-dang-ji-dai-ma/git-sync.md)等内容来自定义并覆盖默认配置。

{% hint style="info" %}
**部分页眉可自适应**，并会根据你当前所在的部分和模式而变化。

例如，如果你正在编辑一个 [更改请求](/docs/documentation/zh/xie-zuo/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%2FrTr3IxB9SPupw4YedgqL%2FCleanShot%202025-12-10%20at%2010.11.01.png?alt=media&amp;token=772809ef-1b4b-453f-9ce4-64883cfc292c" alt=""><figcaption><p>变更请求中的部分页眉。</p></figcaption></figure></div>

部分页眉包括：

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

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

站点工具可从主视图中的站点侧边栏打开。站点页眉会保留 **预览** 以及 **发布**.

在 **常规**:

* **概述**\
  关键信息，包括其 URL、发布状态、受众、内容和顶层洞察。站点上线后， **概述** 会链接到它。
* **变更请求**\
  你站点各部分中的变更请求。
* **网站结构**\
  使用 [结构编辑器](/docs/documentation/zh/guan-li-ni-de-zhan-dian/site-structure.md) 用于添加、重新排序、发布和移除部分与分组。
* **设置**\
  [站点设置](/docs/documentation/zh/guan-li-ni-de-zhan-dian/site-settings.md) 包括 **常规**, **成员**, **代理**, **受众**, **域名和 URL**, **重定向**，以及 **方案**.

在 **工具**:

* **风格指南**\
  你站点的 [样式指南](/docs/documentation/zh/guan-li-ni-de-zhan-dian/site-structure.md) 定义写作规则和约定。GitBook Agent 在编写、编辑或审阅内容时会遵循它。
* **自定义**\
  [自定义你的站点](/docs/documentation/zh/guan-li-ni-de-zhan-dian/customization.md) 包含 **主题**, **布局**, **AI 助手**，以及 **配置** 选项。
* **分析**\
  **AI 洞察** 以及 **分析** 提供 [详细分析](/docs/documentation/zh/fen-xi/insights.md) ，关于你的站点及其表现。
* **扩展**\
  **连接**, **渠道**, **文档嵌入**, **MCP 访问权限**，以及 [**集成**](/docs/documentation/zh/guan-li-ni-de-zhan-dian/install-an-integration.md).

### 内容编辑器

<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%2FxpmoPcLU6kfep6QsXlxi%2FCleanShot%202025-12-10%20at%2010.18.49.png?alt=media&amp;token=af2b3315-f6e0-4a12-b853-1cbbd5e0e0e9" alt=""><figcaption><p>在 GitBook 编辑器中编写内容并添加区块。</p></figcaption></figure></div>

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

插入 [内容区块](/docs/documentation/zh/chuang-jian-nei-rong/blocks.md)，编写 [Markdown](/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown.md), [嵌入内容](/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url.md)，并与 [GitBook Agent](broken://pages/155dafccc07f944f2a09205d69e1c7ba7bea602a).

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

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

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

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

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

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

页面的 **操作菜单** <picture><source srcset="/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%2F89MTSo5XRpPMVr1T0rxS%2Factions.svg?alt=media&amp;token=2b5d001e-560a-4f29-8d22-de8163725ca1" alt="The Actions menu icon in GitBook"></picture> 可让你复制、重命名或删除页面。

在目录中，将鼠标悬停在某个页面上并点击 <picture><source srcset="/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%2F89MTSo5XRpPMVr1T0rxS%2Factions.svg?alt=media&amp;token=2b5d001e-560a-4f29-8d22-de8163725ca1" alt="The Actions menu icon in GitBook"></picture> 图标。你也可以点击页面标题旁边的图标。

{% hint style="info" %}
可用操作取决于你是否使用 [实时编辑](/docs/documentation/zh/xie-zuo/live-edits.md) 或一个 [更改请求](/docs/documentation/zh/xie-zuo/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%2FquMiRmEYl2L5vg76GJWT%2FCleanShot%202025-12-10%20at%2010.24.19.png?alt=media&amp;token=b29ba1c2-0f5f-4d35-9e40-dcc6a27165d3" alt=""><figcaption><p>该 <strong>页面选项</strong> 侧边栏面板为你的文档和导航提供自定义选项。</p></figcaption></figure></div>

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

打开 **页面选项** 从页面的 **操作菜单** <picture><source srcset="/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%2F89MTSo5XRpPMVr1T0rxS%2Factions.svg?alt=media&amp;token=2b5d001e-560a-4f29-8d22-de8163725ca1" 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%2F29FlwGeQG1m2s6nQ8yBv%2FCleanShot%202025-12-10%20at%2010.26.57.png?alt=media&amp;token=6b4e1658-1526-4089-bea4-5bfe5f5656e7" alt=""><figcaption><p>页面大纲显示 H1 和 H2 标题，让你能够快速跳转到单个页面中的特定部分。</p></figcaption></figure></div>

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

大纲列出 H1 和 H2 [标题](/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 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/gitbook-ui.md?ask=<question>&goal=<endgoal>
```

`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.
