全局主题 | Fern Documentation

全局主题允许单个”控制”存储库为您组织的文档定义共享的视觉标识（logo、颜色、字体、布局、CSS、JS 等）。子存储库通过名称引用主题，并在发布时自动继承这些设置。

当您的组织维护多个应该共享相同品牌标识的文档站点时，这非常有用。

设置全局主题

从定义您规范品牌标识的存储库中，导出主题：

$ fern docs theme export

这会从您的 docs.yml 中读取符合主题条件的字段，并生成一个 theme.yml 文件以及在 fern/theme/ 目录中的所有本地资源（logo、字体、CSS、JS）的副本。

使用 --output 指定不同的目录：

$ fern docs theme export --output ./my-theme

上传导出的主题到 Fern 注册表：

$ fern docs theme upload --name my-theme

这会上传主题配置和所有引用的文件资源。如果您省略 --name，主题将保存为 default。

列出您组织的所有主题：

$ fern docs theme list

使用 --json 获取包含 updatedAt 时间戳的机器可读输出：

$ fern docs theme list --json

在子存储库的 docs.yml 中，添加：

docs.yml

1 global-theme: my-theme

从子存储库运行标准的发布命令：

$ fern generate --docs

CLI 从 Fern 注册表获取指定的主题，下载任何文件资源，将主题合并到本地 docs.yml 配置中，并发布合并后的结果。无需额外步骤。

当应用全局主题时，主题的值优先于子存储库 docs.yml 中的品牌字段，而子存储库保留对其内容和结构的控制权。在子存储库中，只编辑由子存储库拥有的字段 — 您对主题拥有字段的任何本地更改在发布时主题合并时会被覆盖。

要更新主题，请对控制存储库的 docs.yml 进行更改，重新导出，并使用相同名称重新上传。下次子存储库发布时，它会自动获取更新的主题。

$ fern docs theme export
$ fern docs theme upload --name my-theme