GitBook 界面

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

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

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

侧边栏

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

侧边栏可让您一目了然地查看 GitBook 组织结构概况。侧边栏包含:

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

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

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

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

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

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

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

  • 空间 “空间”部分是您添加更多内容时会找到 集合空间 的位置。前往我们的 内容结构 部分以了解更多信息。

  • 设置 您将在侧边栏底部找到 个人设置组织设置 。在这里,您还可以切换浅色/深色模式,或在需要时从我们的支持团队获取帮助。

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

目录

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

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

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

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

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

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

  • 创建新的可重用内容

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

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

文件 选项卡中,您可以:

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

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

  • 管理单个文件

如果您想更专注于页面的内容,可以将鼠标悬停在目录旁并单击出现的 隐藏 按钮 The Hide button icon in GitBook 。要再次显示目录,请将鼠标悬停在页面边缘附近并单击出现的 显示 按钮 The Show button icon in GitBook.

空间页眉

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

空间页眉包含有关您当前查看空间的信息。它可让您执行诸如发布和共享空间、查看该空间的评论和历史、配置 GitHub 或 GitLab 同步,以及更多操作。

空间页眉是可适配的,会根据您当前所在的空间和模式而变化。

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

空间页眉包括:

  • 空间表情符号或图标 您可以为空间选择表情符号或图标,以帮助您在侧边栏中轻松识别它。

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

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

  • 操作菜单 The Actions menu icon in GitBook 为您的空间提供一系列操作。类似于 页面操作,空间可用的操作会根据您当前所在的模式而有所不同。

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

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

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

  • 协作者 当前在您空间中查看页面的其他人的头像,带有彩色圆圈以显示他们的光标颜色。单击头像可跳转到他们当前查看的页面。

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

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

  • 评论 查看您和您的团队就空间内容进行的 评论和讨论

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

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

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

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

站点页眉

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

站点页眉包括:

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

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

  • 操作菜单 The Actions menu icon in GitBook 为您的站点提供一系列操作。您可以从此菜单快速访问您的站点或复制其 URL

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

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

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

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

  • 预览 预览选项卡可快速查看已发布站点在桌面和移动显示的浅色和深色模式下的显示效果。

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

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

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

内容编辑器

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

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

页面标题和描述

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

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

您可以通过选择 页面操作 The Actions menu icon in GitBook > 重命名来更改页面的 URL slug。了解更多 页面操作 如下所示。

页面操作菜单

页面的 操作菜单 The Actions menu icon in GitBook 允许您执行诸如复制、重命名或删除页面等操作。

您可以使用出现在侧边栏中将鼠标悬停在页面上时显示的 操作菜单 图标 The Actions menu icon in GitBook 来打开

。也可以从页面标题旁的图标打开。 可用操作的类型将取决于您是处于 实时编辑 变更请求.

模式还是

A GitBook screenshot showing the Page options side panel
模式还是 页面选项

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

您可以使用出现在侧边栏中将鼠标悬停在页面上时显示的 模式还是 使用页面选项,您可以自定义文档的布局和导航。仅在编辑模式下才能访问页面选项。 通过打开页面的 The Actions menu icon in GitBook 操作菜单 并选择选项 模式还是 ,或将鼠标悬停在页面主标题上并在出现时单击

来打开侧边面板。

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

A GitBook screenshot showing the page outline
页面大纲

页面大纲显示 H1 和 H2 标题,允许您快速跳转到单个页面上的特定部分。 页面大纲

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

标题 模式还是 将显示在此处列出的页面大纲中。

页面大纲也会出现在您已发布的站点中。您可以在

最后更新于

这有帮助吗?