项目结构
项目结构
项目结构
本页面提供了 Fern 文档项目的文件和文件夹结构概述。如果你要将文档分布在多个存储库中并发布到同一域名，请参阅 多源文档。
你的文档配置文件存放在 fern 文件夹中：
fern 和 changelog 文件夹是保留名称——如果重命名，Fern 将无法识别它们。所有其他文件夹名称都可以自定义。
pages 文件夹包含构成文档的 Markdown (MDX) 文件。每个 MDX 文件代表文档中的一个页面。文件夹名称可以自定义。
你可以根据文档的部分将 pages 文件夹组织成子文件夹，或者如上所示保持页面扁平化。
assets 文件夹包含文档中使用的任何图片或视频。你可以在 MDX 文件中使用相对路径引用这些资源。文件夹名称可以自定义。
docs.ymldocs.yml 文件是你的 Fern 文档站点的核心。此配置文件控制文档的导航结构、视觉设计、网站功能和托管设置。只有在 docs.yml 导航中引用的文件（或通过folder 配置发现的文件）才会包含在构建中——任何未引用的文件都会被忽略。
有关完整的配置选项，请参阅 docs.yml 参考。
generators.yml要生成 API 参考 文档，你需要提供你的 API 定义。OpenAPI 和 AsyncAPI 规范需要一个带有 api.specs 部分的 generators.yml 文件。你可以选择性地添加一个 groups 部分用于 SDK 生成。
将你的 OpenAPI 规范文件放在 fern/ 目录中（或子文件夹中）。Fern 支持 YAML 或 JSON 格式。
在 generators.yml 中引用它：
你可以选择性地 添加覆盖文件 进行额外的自定义。要查看实际应用，请查看 Fluidstack 的 Fern 配置。
将你的 AsyncAPI 规范文件与 OpenAPI 规范一起放在 fern/ 目录中。在 generators.yml 中引用它：
你可以选择性地 添加覆盖文件 进行额外的自定义。
将多个 API 组织到独立的文件夹中：
apis 文件夹必须使用这个确切的名称。在 docs.yml 中使用与子文件夹名称匹配的 api-name 引用每个 API。要查看实际应用，请查看 Vapi 的 Fern 配置。
fern.config.jsonfern.config.json 文件存储你的组织名称和 Fern CLI 版本。固定版本可以提供确定性构建。
当使用本地安装的 CLI 时，将 version 设置为 "*"。有关详细信息，请参阅 本地安装 Fern CLI。