For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
      • 概览
      • 工作原理
      • 快速开始
      • 自助设置
      • 项目结构
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 工作原理
  • 设置多源文档
  • 示例:实时多源站点
  • 属性
入门

多源文档

让多个团队从各自的仓库发布到同一个文档站点。

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

Reverse proxy setup

下一个

为文档添加公告横幅

企业功能

此功能仅适用于企业计划。如需开始使用,请联系 support@buildwithfern.com。

多源文档将单个文档站点发布到自定义域,分成多个子路径。每个子路径都来自自己的仓库,因此团队可以独立发布更新,而共享的全局主题保持整个站点品牌的一致性。

工作原理

每个仓库在其 docs.yml 中声明一个在共享域下的唯一基础路径。从该仓库运行 fern generate --docs 仅更新其子路径——其他所有子路径保持不变。

有三个配置使其工作:

  1. multi-source: true 在每个仓库的 docs.yml 中的实例上设置,其中 url 和 custom-domain 以相同的基础路径结尾。
  2. 全局主题 存在于专用的控制仓库中,并通过名称从每个源仓库的 docs.yml 中引用。
  3. 多仓库设置 在 Fern Dashboard 中控制域的默认路径和搜索/Ask AI 范围。

例如,NVIDIA 的文档分布在多个独立仓库中,每个仓库都发布到 docs.nvidia.com 上自己的子路径:

  • docs.nvidia.com/nvcf
  • docs.nvidia.com/brev
  • docs.nvidia.com/aiperf
  • docs.nvidia.com/nemo/curator

每个子路径都是独立发布的,但最终用户看到的是一个统一的站点。

根 docs.nvidia.com 本身是 Fern 设置之外的单独站点——多源仅涵盖子路径。Fern 发布的着陆页是可选的(示例),任何子路径组合都可以,包括仅两个。

设置多源文档

1

为全局主题创建控制仓库

控制仓库是一个专用的 Fern 项目,保存你的全局主题——每个源仓库继承的共享 logo、颜色、字体、布局和站点级设置。在其 docs.yml 中定义这些设置,然后导出并上传主题:

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

查看全局主题获取完整设置指南和主题控制的字段列表。

2

配置每个仓库

每个子路径都有自己的仓库(通常由不同团队拥有),与步骤 1 中的控制仓库分开。在每个仓库的 docs.yml 中:

  • 通过名称引用全局主题:global-theme: my-org-theme。
  • 声明一个带有 multi-source: true 和在共享域上唯一基础路径的实例。该基础路径必须出现在 url 和 custom-domain 的末尾。

例如,这里是同一共享域上的两个仓库——一个在 /product-a,一个在 /product-b:

产品 A 仓库
产品 B 仓库
docs.yml
1global-theme: my-org-theme
2
3instances:
4 - url: example.docs.buildwithfern.com/product-a
5 custom-domain: docs.example.com/product-a
6 multi-source: true
3

从每个仓库发布

每个仓库独立发布:

$fern generate --docs

只有该仓库拥有的子路径会被更新。其他所有子路径都不受影响。

4

在 Dashboard 中配置域设置

打开 Fern Dashboard 并选择你的顶级域(例如 docs.example.com)——这些设置适用于整个域,而不是每个子路径。在 Settings 标签页中,导航到 Multi-repo settings 卡片。

配置以下内容:

  • 默认路径 (可选)——设置用户访问域的根目录时的着陆页。当 Fern 管理的页面应该作为根页面时设置此选项。例如,如果你的主页位于 /home 子路径,将默认路径设置为 /home,这样 docs.example.com 就会重定向到 docs.example.com/home。如果根目录不是 Fern 管理的,比如 NVIDIA 的 docs.nvidia.com(Fern 设置之外的单独营销站点),则跳过此设置。
  • 搜索 / Ask AI 行为——控制 Ask Fern 和搜索如何在子路径之间工作。有两种模式可用:
    • 层级模式——在 /subpath 下的搜索仅返回来自 /subpath 及其下层的结果。当每个子路径涵盖不同产品且用户期望范围限定的结果时使用。
    • 统一模式——在任何子路径下的搜索返回来自所有子路径的结果。当子路径是单个产品的各个部分且用户受益于跨领域结果时使用。

Fern Dashboard 中的多源设置

示例:实时多源站点

在 multi-source.docs.buildwithfern.com 浏览实时站点,在 fern-api/docs-examples/multi-source 查看源码。

这是 NVIDIA 设置的替代形式:在根目录有一个 Fern 管理的主页,下面有团队子路径。该示例在一个共享域上使用六个独立的 fern/ 项目——在 / 的主页、带有两个嵌套子项的 /seeds 团队中心,以及独立的 /greenhouses 和 /nursery 团队:

multi-source.docs.buildwithfern.com
/# 主页
/seeds# Seeds 团队中心
/seeds/sunflower# Sunflower 子团队
/seeds/tomato# Tomato 子团队
/greenhouses# Greenhouses 团队
/nursery# Nursery 团队

单位是每个子路径一个 fern/ 文件夹,而不是每个子路径一个仓库。每个仓库一个子路径的布局(通常每个团队一个)是最常见的形式,但单个仓库中的多个 fern/ 文件夹也可以工作。

所有六个项目都共享 global-theme: plantstore-theme 并设置 multi-source: true——它们仅在基础路径上有所不同。子路径本身可以包含嵌套的子路径:/seeds/sunflower 和 /seeds/tomato 是位于 /seeds 下的独立发布项目。

该示例使用 Fern 的预览域(*.docs.buildwithfern.com),所以没有设置 custom-domain。生产部署通常会为每个实例添加 custom-domain: docs.example.com/...。

主页
Seeds(中心)
Sunflower(嵌套)
Greenhouses
homepage/fern/docs.yml
1global-theme: plantstore-theme
2
3instances:
4 - url: multi-source.docs.buildwithfern.com
5 multi-source: true
6
7navigation:
8 - page: Home
9 path: ./pages/home.mdx

主页 home.mdx 可以使用卡片将用户引导到每个团队的文档:

home.mdx
1<CardGroup>
2 <Card title="Seeds" icon="fa-regular fa-seedling" href="/seeds">
3 一个在 `/seeds/sunflower` 和 `/seeds/tomato` 有嵌套子项的中心。
4 </Card>
5 <Card title="Greenhouses" icon="fa-regular fa-warehouse" href="/greenhouses">
6 气候控制和监控。
7 </Card>
8 <Card title="Nursery" icon="fa-regular fa-leaf" href="/nursery">
9 植物护理和繁殖。
10 </Card>
11</CardGroup>

属性

instances.multi-source
boolean

当为 true 时,CLI 使用基础路径感知发布,使多个仓库可以在一个自定义域下共存。启用此功能时,url 和 custom-domain 必须共享相同的基础路径。

global-theme
string

要应用的全局主题的名称。CLI 在发布时从 Fern 的注册表获取指定主题,并将其品牌字段合并到本地 docs.yml 中。查看主题控制的内容获取完整字段列表。