repeat可复用内容

创建可在多个空间中使用的可复用内容块,并在更改实例后一次性更新所有引用

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

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 时,完全支持可复用内容。你的可复用内容将导出到一个专用的 包含 文件夹中,其中每个内容都是一个单独的 Markdown 文件。

然后,你的其他页面会使用 包含 指令来引用这些内容。

circle-info

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

示例

circle-check

最后更新于

这有帮助吗?