sidebarGitBook 界面

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

GitBook 被拆分为不同的部分,以便更轻松地组织和管理你创建的内容。

侧边栏

GitBook 侧边栏包含你的所有文档,以及通知、搜索栏、片段等更多内容。

侧边栏让你可以一目了然地查看 GitBook 组织的概览。侧边栏包含:

  • 组织切换器 如果你属于多个组织,可以在这里查看并在它们之间切换。你也可以通过此菜单创建新组织。

  • 通知 当你在评论或对话中被提及,或者你正在处理的空间中有重要活动时,你会收到一条 通知 来告诉你有哪些新内容。

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

  • 首页 首页可以让你一目了然地查看团队正在进行的所有工作。查看未完成的变更请求、讨论和评论、最近的页面编辑等更多内容。

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

  • 集成 GitBook 集成arrow-up-right 可大幅增强你的内容,让你可以在页面中嵌入更多内容,或从其他应用将信息添加到你的知识库中。

  • 文档站点 切换此部分可在侧边栏中直接查看你组织中的所有 文档站点 ,并可一键跳转到其中一个。

  • 空间 空间部分是你可以找到 集合空间 的地方,这些集合是在添加更多内容时创建的。前往我们的 内容结构 部分了解更多信息。

  • 设置 你会在侧边栏底部找到 个人设置组织设置 。在这里,你还可以切换浅色/深色模式,或者在需要时向我们的支持团队寻求帮助。

  • 废纸篓 已删除的空间会显示在废纸篓中。你可以在七天内恢复它们——之后它们将被永久删除。

目录

目录会列出你所选空间中的所有页面和链接。

默认情况下,目录会显示一个 页面、链接和分组 列表,这些内容共同构成一个空间。你会在侧边栏右侧找到它。它仅对应你当前正在查看的空间。

目录也是你可以查看和管理空间中 可复用内容文件 的地方。

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

资源库 选项卡中,你可以:

  • 查看并搜索该空间中的可复用内容、变量、图片和文件

  • 查看并插入来自其他空间的可复用内容

  • 在资源库中创建或导入新项目

  • 将资源库项目拖放到页面上

  • 双击可重命名任意资源库项目

  • 预览图片

  • 管理并下载图片和文件

下面是一段简短视频,展示你可以如何使用目录,尤其是资源库选项卡:

如果你想让页面内容更突出,可以将鼠标悬停在目录旁边,然后点击出现的 隐藏 按钮 The Hide button icon in GitBook 按钮,暂时将目录隐藏。若要再次显示,将鼠标悬停在页面边缘附近,然后点击 显示 按钮 The Show button icon in GitBook.

空间页眉

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

空间页眉包含你当前正在查看的空间信息。你可以通过它执行诸如发布和共享空间、查看空间的评论和历史、配置 GitHub 或 GitLab 同步等内容来自定义并覆盖默认配置。

circle-info

空间页眉具有适应性,会根据你当前所在的空间和模式而变化。

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

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

变更请求中的空间页眉。

空间页眉包括:

  • 空间表情符号或图标 你可以为你的空间选择一个表情符号或图标,以便在侧边栏中轻松识别它。

  • 空间名称 空间的名称,会显示在侧边栏中,以及在你选择发布时显示在你的文档中。

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

  • 操作菜单 The Actions menu icon in GitBook

    提供该空间的操作列表。与 页面操作类似,空间可用的操作会因你当前所在的模式而有所不同。

  • 概览 查看变更请求时,此选项卡会显示变更请求的标题和描述,以及参与者和审阅者。它还会显示所有变更和评论。

  • 编辑器视图 在此视图中,你可以使用 GitBook 的基于块的编辑器来编辑内容。

  • 变更视图 此视图 高亮显示变更 请求中所做的更改,并使用差异视图进行展示。这非常适合在合并变更请求并将更改上线之前审阅新内容。

  • 预览 此视图可让你在合并变更请求之前快速预览内容。

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

  • Git 同步配置GitHub 和 GitLab 同步 为你的空间提供的配置。

  • 共享菜单 允许你发布和共享你的空间。你也可以通过此菜单邀请他人 协作arrow-up-right

  • 变量 创建并添加可复用变量 以在空间中使用。

  • GitBook Agent 与他人协作处理空间中的变更,使用 GitBook Agent.

  • 评论 请参阅 评论和讨论 来记录你和团队就该空间内容进行过的交流。

  • 变更请求 创建、更新和删除 变更请求 ,用于你的空间中。

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

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

站点页眉

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

站点页眉包括:

  • 站点名称 空间的名称,会显示在侧边栏中,以及在你选择发布时显示在你的文档中。

  • 站点的面包屑导航 返回主文档站点界面的链接。

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

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

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

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

  • 预览 预览选项卡可让你快速查看已发布站点在桌面和移动设备上的浅色和深色模式外观。

  • 集成 该按钮会打开一个模态窗口,让你安装并配置 集成 用于你的站点。

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

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

内容编辑器

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

编辑器是你空间的主要部分,你可以在 GitBook 中编写或插入内容。它支持多人协作,这意味着你和你的团队可以实时协作处理更改。

你可以插入 内容块,键入 Markdown, 嵌入内容,并与 GitBook Agent.

除处理变更外,你还可以对块发表评论、标记队友等等。

页面标题和描述

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

你的页面描述最长可为 200 个字符,并会作为页面在搜索引擎中的预览文本。

circle-info

你可以通过选择 页面操作 The Actions menu icon in GitBook > 重命名来更改页面的 URL slug。了解更多关于 页面操作 下面的信息。

页面操作菜单

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

你可以打开 操作菜单 ,使用悬停在侧边栏中页面上方时出现的 The Actions menu icon in GitBook 图标,或者点击页面标题旁边的图标。

circle-info

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

页面选项

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

通过页面选项,你可以自定义文档布局和导航。只有在编辑模式下才能访问页面选项。

你可以打开 页面选项 侧边面板,方法是打开页面的 操作菜单 The Actions menu icon in GitBook 并选择 选项,或者将鼠标悬停在页面主标题上并在出现时点击 页面选项

circle-info

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

页面大纲

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

页面大纲 位于编辑器右侧,让你可以轻松直接跳转到你要查找的页面部分。

你添加到页面中的任何 标题 都会显示在此处列出的页面大纲中。

页面大纲也会出现在你已发布的站点中。你可以在 页面选项 侧边栏

circle-info

如果你看不到应用的右侧栏,可能是因为你的浏览器窗口宽度小于 1430 像素。要查看和使用页面大纲,你的浏览器窗口宽度需要至少为 1430 像素。

最后更新于

这有帮助吗?