术语表
一笔
操作菜单: 在 GitBook 界面中,单击页面或条目旁边的三个点时打开的菜单。根据你当前的视图模式,操作菜单可能会显示不同的选项。
新建: 位于某个分区目录底部的按钮/菜单,可让你向该分区添加新内容。也可用于指代 + 按钮,位于 Docs 站点 侧边栏中的标题,单击它即可创建新站点。
询问或搜索: GitBook 中用于搜索内容的工具。你可以单击侧边栏顶部将其打开,或按下 ⌘ + K。你可以输入关键词进行标准搜索,或者使用 GitBook AI 提问,它会基于你的内容总结结果。
受众设置: 决定哪些人可以访问已发布文档站点的设置。参见 发布一个文档站点 以了解 受众设置菜单.
B
区块: 你添加到页面中的每一项内容都存在于一个区块中。区块有很多不同类型,允许你添加文本、图片、表格、代码、API 参考、嵌入内容等更多内容。你可以拖动区块来移动它,修改其设置,并且在某些情况下,从区块的 选项菜单.
C
变更请求: 变更请求类似于 GitHub 中的拉取请求。它们让你可以并行处理同一分区的多个分支,同时保持原始版本不变。在 GitBook 中,你可以创建新的变更请求并对某个分区进行编辑,然后提交更改供审核。在有人合并该变更请求之前,这些更改不会出现在主分区中。
上下文菜单: 编辑器中高亮文本上方出现的菜单。你可以用它以多种方式格式化文本,包括加粗、斜体和代码,或为你的内容添加链接或注释。
评论: 一个侧边面板,可让你为页面上的任何区块添加评论。你可以回复评论来创建一个 讨论,使用 @ 标记他人,并为评论添加表情符号。你还可以用表情符号回复评论、解决已不再相关的评论,并通过筛选只查看你需要的评论。
封面: 位于页面顶部的图片。你可以为任何页面添加封面,并将其设置为横跨页面全宽,或仅按内容宽度显示为主视觉图。参见 页面 了解更多。
自定义域名: 可为文档站点设置的自定义 URL,例如 docs.yourcompany.com。你可以在 设置 文档站点的面板中进行配置。参见 设置自定义域名 了解更多。
D
差异视图: 一个切换开关,用于高亮显示在变更请求中新增、编辑或删除了哪些页面和区块。你可以使用 查看更改 中的按钮 章节标题.
讨论: 当你回复评论时,你会创建一个讨论——本质上是在评论侧边面板中的线程式对话。
文档站点: 包含在 GitBook 编辑器中编写信息的已发布站点。没有 GitBook 账户的用户也可以访问文档站点。
域名: 文档站点 URL 的基础部分。你可以从 域名 在你站点的 设置 页面。 设置自定义域名 中,这一设置会被覆盖。
E
编辑器: 你登录应用后看到的 GitBook 界面。GitBook 基于区块的编辑器支持 Markdown,并提供所见即所得编辑工具,你可以添加和移动 区块 在页面中到处移动。
F
文件: 图片、视频和其他可上传到分区的项目。你可以在 资料库 标签页,旁边 页面 在目录顶部
G
Git 同步: Git Sync 可让你将 GitHub 或 GitLab 仓库与 GitBook 同步,并将 Markdown 文件转换为文档。这是双向同步,因此你在 GitBook 中所做的更改会出现在你的仓库中,而你直接在 GitHub 或 GitLab 中所做的更改也会更新到 GitBook 中。你可以通过将 GitHub Sync 或 GitLab sync 集成添加到你的组织来设置 Git Sync。了解更多
GitBook AI: 一个基于你的知识库和文档训练的 AI 助手,用于 回答问题。你可以通过 提问或搜索 菜单向 GitBook AI 询问有关你的文档的任何问题。你也可以让 GitBook AI 帮你 撰写或编辑你的内容 在编辑器中。
分组: 一组相关的分区。你可以把分组看作是分区的文件夹。
I
行内面板: 类型 / 当 在区块中间 中启用 编辑器 即可打开行内面板。它让你可以快速向区块中添加不同类型的行内内容,从图片和表情符号到 Math 和 TeX。
插入面板: 类型 / 于 一个空区块 即可打开插入面板。它会显示你可以创建的所有可用区块,包括插件和可复用内容。你可以搜索区块以缩小选择范围,并使用键盘或光标进行选择。
数据洞察: GitBook 内置的文档站点分析工具,可让你查看已发布文档站点上的页面浏览量、反馈和热门搜索。
集成: GitBook 集成可让你将 GitBook 内容连接到第三方服务和平台。你可以从“集成”菜单在组织中的任何分区安装集成。
L
实时编辑: 无需创建变更请求即可对文档的实时版本进行更改的能力。这是未发布 GitBook 分区的默认选项。
锁定实时编辑: 当你锁定实时编辑时,用户需要创建变更请求才能更改 GitBook 中的文档。这有助于避免错误,并为重要文档保持良好的工作流程。你可以为任何分区锁定实时编辑——且它会自动为已发布分区启用。
M
成员管理: 允许你查看和编辑组织成员的工具,包括他们的管理员权限以及可访问的内容。
O
选项菜单: 单击区块旁边的六个点时打开的菜单。在这里你可以更改区块的外观。单击并拖动这六个点可在页面中移动区块。
P
页面: 一个可使用区块添加或编写内容的地方。页面位于一个 部分,并且你可以为每个页面添加标题以及可选的图标或表情符号。
页面组: 将页面分组的一种方式。你可以为每个页面组设置名称以及可选的图标或表情符号。
页面选项: 可通过 页面选项 侧边面板为页面选择的一组选项。你可以选择布局预设,或控制单独选项,例如隐藏页面标题和描述、目录或页面大纲。了解更多请见 页面.
R
可复用内容: 在分区中跨多个位置同步的内容。当你创建 可复用内容 时,你可以根据需要将其添加到一个分区中任意多次,然后同时编辑所有这些实例。你可以从一个分区的可复用内容 资料库 标签页,旁边 页面 在顶部的 目录.
S
分区: 一个用于组织相关内容的区域。它可以包含单个页面或多个页面、子页面和页面组。分区属于文档站点,并会显示在已发布文档顶部的标签栏中,方便用户在内容之间切换。你可以从站点的 部分 从 网站结构,在 常规 站点侧边栏中。
分区标题: 查看分区时,位于分区概览下方的菜单栏。它包含分区标题和图标,以及用于查看评论、断链和变更请求的按钮,以及 编辑 按钮。
侧边栏: GitBook 窗口最左侧的区域。它包含 提问或搜索 栏、你的文档站点和内容,以及通知、集成和设置等内容。
slug: URL 可自定义的最后一部分,通常位于域名和 / 之后。在文档站点中,它会根据站点标题推断,并位于域名之后。如有需要,你可以进一步从 域名 分区的 站点设置.
子页面: 嵌套在另一个页面中的页面,通常包含相关内容。
T
V
变体:A 变体 是文档的不同版本——例如,你的文档的翻译版本,或你的产品某个不同版本号的文档。站点读者可以使用已发布站点中的下拉菜单在不同变体之间切换。
版本: 你在特定时间点保存的分区快照。你可以在 版本历史 菜单。
版本历史: 显示分区主要事件的菜单——例如创建日期、你合并的任何变更请求,以及有人回滚到先前版本的时间。你可以单击任意版本查看该分区当时的样子,并在需要时回滚到先前版本。
最后更新于
这有帮助吗?