内容变体

在单个站点中发布多个产品版本或语言的文档

您可以将同一份文档的多个版本作为单个 docs 站点的一部分发布。这些变体将通过已发布站点左上角的空间切换器供最终用户使用。

A GitBook screenshot showing a docs site's structure

添加多种语言或版本

如果您需要将各个空间的内容汇总在一起,多变体站点会很有用——例如,您正在记录某个 API 的多个版本(v1、v2、v3 等),或者用不同语言记录您的内容。

circle-info

您链接的空间可以包含任何内容,但建议将变体用作 相同内容的不同变体。如果您链接的空间在语义上彼此不同,请考虑改为将它们添加为 站点分区

当将翻译或多种语言作为变体添加时,最佳实践是为变体设置语言,以便用户在浏览文档时获得最佳体验。

添加带有已设置语言的多个变体后,语言选择器会移动到右上角,相比默认的变体选择器,体验会更简洁、更直接。

向 docs 站点添加变体

在 docs 站点仪表板中,打开 设置 选项卡,然后点击站点标题中的 结构。在这里您可以看到站点的全部内容。

要添加变体,请点击您希望添加到的分区中的 添加变体 按钮,然后选择要链接的空间。新的变体随后会添加到所选分区的变体列表中,并会在您站点的变体下拉菜单中向访问者显示。

更改变体

您可以通过点击要编辑的变体所在行中的 The Edit icon in GitBook 编辑 按钮来更改每个变体的名称和 slug。这将打开一个模态窗口。编辑您想更改的字段,然后点击 保存 按钮进行保存。您也可以点击 删除变体 按钮(位于左下角)来删除该变体。

如果您的站点支持多种语言,您还可以翻译变体标题,这样选择器就会显示本地化标签。另请参见 多语言分区.

circle-info

更改已链接空间的 slug 会更改该空间的规范 URL。GitBook 会从旧 URL 自动重定向到新 URL。您也可以 手动创建重定向.

要用另一个空间替换某个变体所链接的空间,请先点击其 编辑 The Edit icon in GitBook 按钮将其删除,然后点击模态窗口左下角的 删除 按钮。删除变体后,点击 添加变体 按钮添加新空间。

重新排序变体

您的站点会按它们在 站点结构 表格中出现的顺序显示变体。可通过拖动 拖拽手柄 The Options menu icon in GitBook 并上下移动来重新排序变体。更改后的顺序会立即反映到您的站点上。

您也可以使用键盘选择并移动内容:按空格键选择某个分区或变体,然后使用方向键将其上下移动。再次按空格键以确认新位置。

设置默认变体

如果某个分区中有多个变体,其中一个会被标记为默认变体。当访问者进入您的站点时(或访问某个分区时)会显示此变体。其他变体各自拥有一个附加到站点 URL 的 slug。

要将某个变体设为默认,请点击 操作菜单 The Actions menu icon in GitBook 中的该变体表格行,然后点击 设为默认.

circle-info

将某个变体设为默认后,其 slug 字段会被移除,因为它将改为从该分区根路径提供。GitBook 会将该变体的 slug 重定向到相应路径,以确保访问者继续看到您的内容。

从站点中移除变体

要从站点中移除某个变体,请打开 docs 站点仪表板中的 设置 选项卡,然后点击 结构 以找到您要移除的内容。

打开 操作菜单 The Actions menu icon in GitBook 中您要移除的变体对应的菜单,然后选择 移除.

circle-check

最后更新于

这有帮助吗?