可重用内容

创建可跨空间使用的可重用内容块,修改某一实例时所有实例都会同时更新

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

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

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

基础知识

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

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

“父空间”概念

父空间是拥有可重用内容的空间。它是唯一可以编辑该内容的地方。

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

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

已知限制

集成

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

搜索

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

在应用中

创建可重用内容

要创建可重用内容, 选择一个或多个块,然后打开 操作菜单 The Actions menu icon in GitBook ,选择 转为,并选择 可复用内容。您也可以为块命名,以便稍后更容易查找和重用。

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

插入可重用内容

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

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

编辑可重用内容

可重用内容与其他内容一样——如果 如果您的空间已发布,或有人锁定了 已启用,您可以直接编辑任何实例,或者通过 变更请求 若未启用。您所做的任何更改都将同步到内容被使用的所有地方。

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

分离可重用内容

您可以通过打开 操作菜单 The Actions menu icon in GitBook 并选择 分离来分离可重用内容。分离将把内容转换回普通块。

一旦分离,您对该块(或块组)所做的任何更改将不会反映在其他实例中,您在那些实例中所做的更改也不会反映在已分离的块(或块组)中。可重用内容的所有其他实例仍然保持相互同步。

删除可重用内容

如果您愿意,可以完全从空间中删除可重用内容。在页面的目录中找到该可重用内容,然后打开 操作菜单 The Actions menu icon in GitBook 位于您想删除的内容旁边,选择 删除.

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

与 GitHub & GitLab 的同步

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

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

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

示例

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

最后更新于

这有帮助吗?