Fern 文档的工作原理
Fern 文档的工作原理
Fern 文档的工作原理
Fern 将您的 API 规范、静态 Markdown 文件（如操作指南和教程）、媒体资源（图像、视频等）以及在 docs.yml 文件中定义的自定义设置结合起来，生成一个美观、交互式的托管文档站点。
此过程围绕两个主要工作流程构建：编辑和部署您的文档。
此图显示了为文档生成过程提供支持的技术基础设施。
您可以通过两种方式更新您的文档：
docs.yml 配置和 Markdown 文件）。更新通过您的审核流程后，审批者可以合并它。
您可以使用 Fern Dashboard 管理您的 GitHub 仓库连接、组织成员（添加或删除）、域名和 Fern CLI 版本。
当拉取请求合并到您的文档仓库时，自动化管道将您的内容转换为实时文档站点，并通过三个主要阶段与您的 API 更改同步：
合并的 PR 触发 Fern GitHub Action。该操作使用安全令牌身份验证从单独的仓库检索您的 API 规范。GitHub Action 只能访问运行它的特定文档仓库。
Fern CLI 运行 fern generate --docs 来合并您的 API 规范与文档内容。在幕后，此过程涉及几个关键组件：
docs.yml 配置文件、.mdx 文件和媒体内容。处理后的内容被部署到 Vercel 作为文档站点，嵌入了 API Explorer，允许用户直接在文档内测试端点。
Vercel Edge 中间件处理底层路由、身份验证和性能优化。
部署的文档站点与外部系统集成，如 Cloudflare 用于 CORS 管理，WorkOS 用于企业身份验证。
此图显示了内容如何从编辑流向部署。