可重用内容

创建可在多个空间中使用的可重用内容块,更改某个实例时可一次性更新全部

此功能可在以下方案中使用 专业版与企业版计划.

可重用内容允许你在多个页面和空间之间同步内容,因此你可以同时编辑该块的所有实例。

A GitBook screenshot showing reusable content
在某个空间内创建可重用内容。

基础知识

可重用内容的工作方式与其他内容相同——你可以通过变更请求修改它,将其纳入审查工作流,并且它将在任何已发布的网站上正确呈现。

虽然可重用内容可以在多个空间中被引用,但它属于单一 父空间.

“父空间”概念

父空间是拥有可重用内容的空间。只有在该空间中才能编辑该内容。

尽管对可重用内容的更新会立即出现在所有实例中,但所有更改必须源自父空间——要么作为直接编辑,要么通过变更请求。

空间是 GitBook 的核心概念,支持编辑工作流和安全性。由于 GitBook 强制基于权限的编辑,可重用内容只能从其父空间更改。这确保了即便内容在组织内被重复使用,也会尊重编辑权限。

已知限制

集成

集成提供的块不支持可重用内容。这是因为 GitBook 中的集成是按空间安装的,限制访问可以确保第三方集成仅具有你授予的权限。在不同空间引用可重用内容会破坏此安全边界。

搜索

目前,可重用内容仅在其父空间的搜索结果中出现。我们正在积极努力移除此限制,以便可重用内容在其被引用的任何位置的搜索结果中都能显示出来。

在应用内

创建可重用内容

要创建可重用内容, 选择一个或多个块,然后打开 操作菜单 ,选择 转换为,并选择 可重用内容。你也可以为你的块命名,以便以后更容易查找和重用。

或者,你可以选择一个或多个块然后按下 Cmd + C 以打开一个提示,询问你是否要创建可重用内容。

插入可重用内容

你可以像插入其他块一样插入可重用内容。按下 / 在空行上打开 插入面板 并按名称或直接搜索“reusable”来查找你的内容。或者,点击任何块或空行左侧的 +

你还可以在页面侧边栏中找到可重用内容面板,在那里可以找到当前空间中之前创建的内容块列表。

编辑可重用内容

可重用内容就像其他内容一样——如果 实时编辑 已启用,你可以直接编辑任何实例,或者通过 变更请求 如果未启用。你所做的任何更改都会在该内容被使用的所有地方同步。

如果你在变更请求中进行更改,一旦该变更请求合并,内容将同步到所有其他实例。

分离可重用内容

你可以通过打开 操作菜单 并选择 分离来分离可重用内容。分离将把内容转换回常规块。

分离后,你对该块(或这些块)所做的任何更改将不会反映到其他实例中,而你在那些实例中所做的更改也不会反映到已分离的块(或这些块)中。可重用内容的所有其他实例仍然彼此同步。

删除可重用内容

如果愿意,你可以从你的空间中完全删除可重用内容。在页面的目录中找到该可重用内容,然后打开 操作菜单 位于要删除的内容旁边的 删除.

删除可重用内容将会 从其被使用的所有页面中删除它。此操作无法撤销。

与 GitHub 与 GitLab 的同步

在同步到 GitHub 与 GitLab 时完全支持可重用内容。你的可重用内容将被导出到一个专门的 includes 文件夹中,每个内容作为单独的 Markdown 文件。

然后在其他页面中使用 includes 指令来引用你的内容。

在同步时, .gitbook/includes 目录会在每个被同步空间的根目录下创建(该根目录可能不是整个仓库的根)。如果你的 .gitbook/includes 文件夹或其文件出现在你空间的目录中,你可能需要手动将它们从目录中隐藏。

示例

{% include "../../.gitbook/includes/reusable-block.md" %}

最后更新于

这有帮助吗?