术语表

一项

操作 菜单: 当你点击 GitBook 界面中页面或条目旁边的三点时打开的菜单。操作菜单可能会根据你当前的查看模式显示不同的选项。

添加 新内容: 位于空间目录底部的按钮/菜单,让你向空间添加新内容。也用于指代 + 位于侧边栏中 文档站点 并且 空间 部分标题旁的按钮,你可以点击这些按钮创建新的站点、空间或集合。

提问或搜索: GitBook 中的内容搜索工具。你可以点击侧边栏顶部打开它,或按下 ⌘ + K。你可以输入关键词进行标准搜索,或使用 GitBook AI 提问,AI 会基于你的内容汇总出结果。

受众 设置: 决定谁可以访问已发布文档站点的设置。有关 发布文档站点 中选项的更多信息,请参阅 受众 设置 菜单.

B

区块: 你在页面中添加的每一段内容都存在于一个区块中。区块有许多不同类型,允许你添加文本、图片、表格、代码、API 参考、嵌入内容等。你可以通过拖拽移动区块,修改其设置,并在某些情况下将一种区块更改为另一种类型,通过区块的 选项菜单.

C

变更 请求: 变更请求类似于 GitHub 中的 pull request。它们允许你在同一空间的多个分支上并行工作,同时保持原始版本不变。在 GitBook 中你可以创建新的变更请求并对空间进行编辑,然后提交更改以供审核。在有人合并该变更请求之前,这些更改不会出现在主空间中。

集合: 一组空间。你可以把集合想象成存放空间的文件夹。

上下文 菜单: 出现在编辑器中高亮文本上方的菜单。你可以用它以多种方式格式化文本,包括加粗、斜体和代码,或为文本添加链接或注释。

评论: 一个侧边面板,允许你向页面上的任何区块添加评论。你可以回复评论以创建一个 讨论,使用 @ 标记人员并在评论中添加表情。你还可以用表情对评论做出反应,解决已不再相关的评论,并筛选以仅查看所需的评论。

封面: 位于页面顶部的图像。你可以为任何页面添加封面,并设置其为跨页面全宽显示,或仅以英雄图像的形式跨内容宽度显示。参见 页面 以了解更多信息。

自定义 域名: 你可以为文档站点设置的自定义 URL,例如 docs.yourcompany.com。你可以在你的文档站点的 设置 面板中进行配置。参见 设置自定义域名 以了解更多信息。

D

差异 视图: 一个切换项,用于突出显示在变更请求中已添加、编辑或删除的页面和区块。你可以使用 查看更改 按钮位于 空间标题.

讨论: 当你回复一条评论时,会创建一个讨论——实际上是在评论侧边面板内的线程化对话。

文档 站点: 包含在 GitBook 编辑器中编写信息的已发布站点。文档站点可供没有 GitBook 帐户的用户访问。

域名: 文档站点 URL 的基础部分。你可以在站点的 域名 部分中自定义此项,位于站点的 设置 页面。 设置自定义域名 将覆盖此设置。

E

编辑 器: 你登录应用时看到的 GitBook 界面。GitBook 的基于区块的编辑器提供 Markdown 支持和所见即所得的编辑工具,你可以添加并移动 区块 在页面上。

F

文件: 你可以上传到空间的图片、视频和其他项。你可以通过打开位于内容左侧目录顶部的 文件 选项卡来查看和管理你的文件

G

Git 同步: Git 同步 允许你将 GitHub 或 GitLab 仓库与 GitBook 同步并将 Markdown 文件转为文档。这是双向同步,因此你在 GitBook 中所做的更改会出现在你的仓库中,而你在 GitHub 或 GitLab 中直接做的更改也会更新到 GitBook。你可以通过向组织添加 GitHub Sync 或 GitLab Sync 集成来设置 Git 同步。了解更多

GitBook AI: 一个基于你的知识库和文档训练的 AI 助手,用于 回答 问题。你可以从 提问或搜索 菜单向 GitBook AI 询问关于你的文档的任何问题。你也可以请 GitBook AI 在编辑器中帮助你 撰写 或 编辑 你的内容

I

内联 调色板: 输入 /在区块中间编辑 器 以打开内联调色板。它让你快速向区块添加不同类型的内联内容,从图片和表情到数学与 TeX。

插入 调色板: 输入 /一个空 区块 中打开插入调色板。它显示你可以创建的所有可用区块,包括插件和可重用内容。你可以搜索区块以缩小选择,并使用键盘或光标进行选择。

洞察: GitBook 为文档站点提供的内置分析工具,让你查看已发布空间的页面浏览量、反馈和热门搜索。

集成: GitBook 集成允许你将 GitBook 空间连接到第三方服务和平台。你可以从集成菜单在组织中的任何空间安装集成。

L

实时 编辑: 对文档的实时版本进行更改的能力,而无需创建变更请求。这是未发布 GitBook 空间的默认选项。

锁定 实时 编辑: 当你锁定实时编辑时,人员需要创建变更请求才能在 GitBook 中对文档进行更改。这有助于避免错误并为重要文档保持良好的工作规范。你可以为任何空间锁定实时编辑——已发布的空间会自动启用此项。

M

成员 管理: 允许你查看和编辑组织中成员的工具,包括他们的管理员权限以及他们有权访问的空间。

O

选项 菜单: 当你点击区块旁的六个点时打开的菜单。在这里你可以更改区块的外观。点击并拖动这六个点即可在页面上移动区块。

P

页面: 一个你可以使用区块添加或撰写内容的地方。页面存在于一个 空间中,你可以为每个页面设置标题以及可选的图标或表情。

页面 组: 将页面分组在一起的一种方式。你可以为每个页面组设置名称和可选的图标或表情。

页面 选项: 你可以使用 页面选项 侧边 面板为页面设置的一组选项。你可以选择布局预设,或控制单独选项,例如隐藏页面标题和描述、目录或页面大纲。在 页面.

中了解更多

可重用 内容: 在空间的多个位置同步的内容。当你创建 可重用 内容 时,你可以根据需要多次将其添加到空间中,然后同时编辑所有这些实例。你可以从 可重用内容 位于侧边栏顶部的选项卡查看和管理空间的可重用内容 目录(Table of Contents).

S

侧边 栏: 位于 GitBook 窗口最左侧的区域。它包含 提问或搜索 栏、你所有的文档站点、空间和集合,以及通知、集成和设置等内容。

站点 部分: 如果你希望你的文档站点更像一个内容中心,你可以将多个空间作为 站点部分发布到同一个文档站点。这些站点部分会出现在已发布文档顶部的选项卡栏中,允许用户在内容之间切换。你可以在 结构 的 部分 设置站点部分 站点设置.

别名: URL 的可自定义最终部分,通常位于域名和 / 之后。在文档站点中,这部分通常从站点标题推断而来,位于域名之后。如果需要,你也可以从 域名 的 部分 设置站点部分 站点设置.

空间: 你可以组织相关内容的区域。它可以包含单个页面或多个页面、子页面和页面组。

空间 头部: 当你查看空间时位于空间概览下方的菜单栏。它包含空间标题和图标,以及用于查看评论、断链和变更请求的按钮,还有 在变更请求中编辑 按钮。

空间 概览: 当你查看空间时位于 GitBook 应用顶部的菜单栏。它包含该空间的面包屑导航,以及用于该空间的 Git 同步 配置 按钮、共享 按钮,和 操作按钮 。如果有其他人在与你同时在该空间内工作,你还会在此处看到他们的头像。

子页面: 嵌套在另一页面内的页面,通常包含相关内容。

T

目录: 构成空间的文档页面、链接和分组的列表。你可以在页面左侧、侧边栏旁找到它。目录(TOC)还允许你访问空间的 可重用 内容 并且 文件。你可以将鼠标悬停在目录右上方附近以折叠它。

V

变体: 一个 变体 是你的文档的不同版本——例如,你的文档的翻译版本,或适用于产品不同版本号的文档。站点阅读者可以在已发布站点上的下拉菜单中在不同变体之间切换。

版本: 在特定时间保存的空间快照。你可以在 版本历史 菜单中访问空间的历史版本。

版本 历史: 显示空间主要事件的菜单——例如其创建日期、你合并的任何变更请求,以及任何人回滚到先前版本的时间。你可以点击任一版本以查看该时间点空间的样子,并在需要时回滚到先前版本。

最后更新于

这有帮助吗?