GitBook 界面

了解 GitBook 编辑器中不同的组件和界面

GitBook 被拆分为不同的部分,以便更容易组织和管理您创建的内容。

侧边栏

A GitBook screenshot showing the sidebar
GitBook 侧边栏包含您所有的文档,以及通知、搜索栏、片段等。

侧边栏允许您一目了然地查看和概览您的 GitBook 组织。侧边栏包含:

  • 组织切换器 如果您属于多个组织,您可以在此查看并切换它们。您也可以从此菜单创建一个新组织。

  • 通知 当您在评论或对话中被提及,或当您正在工作的空间中有重要活动时,您会收到一条 通知 来向您展示有什么新内容。

  • 提问或搜索 由以下提供技术支持 GitBook AI,您可以用自然语言提问,或在组织中的不同空间和内容中进行搜索。

  • 首页 首页让您一目了然地查看团队正在处理的一切。查看未完成的变更请求、讨论和评论、最近的页面编辑等。

  • 文档站点首页 点击此处可访问您在组织中创建的所有文档站点的概览页面。

  • 集成 GitBook 集成 可为您的内容提供增能,允许您在页面中嵌入更多内容,或从其他应用向您的知识库添加信息。

  • 文档站点 切换此部分以在侧边栏中查看所有 文档站点 并一键跳转到其中一个。

  • 空间 空间部分是您添加更多内容时会找到 集合 并且 空间 您创建的地方。前往我们的 内容结构 部分以了解更多信息。

  • 设置 您会在侧边栏底部找到 个人设置 并且 组织设置 。在这里,您还可以切换亮/暗模式,或在需要时从我们的支持团队获得帮助。

  • 回收站 已删除的空间会出现在回收站中。您可以在最多七天内恢复它们——之后它们将被永久删除。

目录

A GitBook screenshot showing the table of contents
目录列出所选空间中的所有页面和链接。

默认情况下,目录显示由其组成的 页面、链接和分组 的列表。您会在侧边栏的右侧找到它。它针对您当前查看的空间特定显示。

目录也是您可以查看和管理 可重用内容 并且 文件 的地方,属于您的空间。

在目录的 页面 选项卡中,您可以:

可重用内容 选项卡,您可以:

  • 查看并搜索空间中的可重用内容

  • 创建新的可重用内容

  • 将可重用内容拖放到页面上

  • 重命名和删除可重用内容

文件 选项卡,您可以:

  • 查看、搜索并重新排序空间中的文件

  • 将更多文件拖放到您的空间中

  • 管理单个文件

如果您想更专注于页面内容,您可以将光标悬停在目录旁并点击出现的 隐藏 按钮 来暂时隐藏目录。要再次显示它,请将光标悬停在页面边缘附近并点击出现的 显示 按钮 .

空间头部

A GitBook screenshot showing the space header
空间头部位于编辑器顶部,提供适用于整个空间的选项。

空间头部包含有关您当前查看空间的信息。它允许您执行诸如发布和共享空间、查看该空间的评论和历史记录、配置 GitHub 或 GitLab 同步等操作。

空间头部是可适应的,会根据您当前所在的空间和模式而变化。

例如,如果您正在编辑一个 变更请求,您将看到打开编辑器、查看更改和合并变更请求的选项。如果您正在查看只读空间,您可以选择打开新的变更请求,但不会有编辑器选项。

空间头部包括:

  • 空间表情或图标 您可以为空间选择一个表情或图标,以便在侧边栏中更容易识别它。

  • 空间名称 将在侧边栏中显示的空间名称,如果您选择发布,它也将出现在您的文档中。

  • 空间的面包屑 空间所在的集合或文档站点的完整线性列表。

  • 操作菜单

    为您的空间提供一个操作列表。类似于 页面操作,空间的可用操作会根据您当前的模式而有所不同。

  • 编辑器视图 此视图是您可以使用 GitBook 的基于区块的编辑器对内容进行编辑的地方。

  • 更改视图 此视图 突出显示变更 使用差异视图显示在变更请求中所做的更改。此视图非常适合在合并变更请求以将更改发布到线上之前审查新内容。

  • 预览 此视图允许您在合并变更请求之前快速查看内容预览。

  • 协作者 当前正在查看您空间中页面的其他任何人的头像,并用彩色圆圈显示他们的光标颜色。点击头像可跳转到他们当前查看的页面。

  • Git 同步配置用于您空间的 GitHub 与 GitLab 同步 配置。

  • 共享菜单 允许您发布并共享您的空间。您还可以通过此菜单邀请其他人 协作

  • 损坏的链接 任何 已损坏的链接 在当前空间或变更请求中被发现的链接。

  • 变更请求 在您的空间中创建、更新和删除 变更请求

  • 空间历史 查看 版本历史 ,其中包含一段时间内在该空间——或您当前的变更请求中——所做的所有更改。

  • 编辑按钮 如果您的空间已发布,或有人已锁定 实时编辑,则 编辑 按钮会出现在空间头部。它将创建一个新的 变更请求 以编辑内容。

站点头部

站点头部包含有关您当前查看站点的信息。它允许您执行诸如查看站点洞察、自定义站点、更改其设置并在不同模式和屏幕尺寸下预览站点等操作。您还可以配置集成并管理成员访问权限。

站点头部包括:

  • 站点名称 将在侧边栏中显示的空间名称,如果您选择发布,它也将出现在您的文档中。

  • 站点的面包屑 返回主文档站点屏幕的链接。

  • 操作菜单

    为您的站点提供一个操作列表。您可以从此菜单快速访问站点或复制其 URL

  • 概述 站点概览向您展示有关站点的基本信息,包括其 URL、发布状态、受众和内容,以及顶层洞察。

  • 洞察洞察面板 为您提供有关站点及其表现的详细分析。

  • 自定义 在这里您可以 自定义您的站点 ,使用您自己的徽标、颜色、头部链接等更多内容。

  • 设置 访问您的 站点设置 并控制名称、受众、内容结构和其他选项。

  • 预览 预览选项卡让您快速查看已发布站点在桌面和移动显示中、亮暗两种模式下的外观。

  • 集成 该按钮会打开一个模态窗口,让您为站点安装和配置 集成

  • 成员访问 查看并管理谁可以在 GitBook 应用中访问您的站点,以及他们拥有什么权限。

  • 访问站点 点击此处可在新标签页中立即打开已发布的文档站点。仅当站点已上线时才会显示此按钮。

内容编辑器

编辑器是您空间的主要部分,在这里您可以在 GitBook 中编写或插入内容。

除了可以插入的多种 内容区块 外,您还可以 嵌入内容 并使用某些 集成.

页面标题和描述

在每个页面顶部,您可以设置一个 标题,添加一个可选的 表情符号,并撰写一个 描述。您使用的标题将出现在目录中,并在发布时形成页面的 URL slug。

您的页面描述最多可包含 200 个字符,并将作为搜索引擎中页面的预览文本。

您可以通过选择 页面操作 > 重命名来更改页面的 URL slug。更多信息请参见 页面操作 下文。

页面操作菜单

页面的 操作菜单 允许您执行例如复制、重命名或删除页面的操作。

您可以使用出现在侧边栏中将鼠标悬停在页面上时显示的 操作菜单 图标打开 ,或从页面标题旁边的图标打开。

可用操作的类型将取决于您当前是处于 实时编辑 模式还是 变更请求.

页面选项

A GitBook screenshot showing the Page options side panel
页面选项 侧边面板为您的文档和导航提供自定义选项。

使用页面选项,您可以自定义文档布局和导航。仅在编辑模式下才能访问页面选项。

您可以使用出现在侧边栏中将鼠标悬停在页面上时显示的 页面选项 通过打开页面的 操作菜单 并选择 选项,或将鼠标悬停在页面主标题上并在出现时点击 页面选项 来打开侧边面板。

某些更改(例如禁用目录)仅适用于已发布的文档,可能在编辑器中不可见。

页面大纲

A GitBook screenshot showing the page outline
页面大纲显示 H1 和 H2 标题,使您可以快速跳转到单个页面上的特定部分。

页面大纲 位于编辑器的右侧,使您可以轻松直接跳转到所需的页面部分。

任何 您添加到页面的一级或二级标题区块 将出现在此处列出的页面大纲中。

页面大纲也会出现在您的已发布站点中。您可以在 页面选项 侧边面板中选择它,在空间中的任何位置引用它。

中将其打开或关闭。

最后更新于

这有帮助吗?