文档快速入门
文档快速入门
文档快速入门
使用Fern构建与您品牌匹配的精美开发者文档。Fern支持用Markdown编写页面，并从OpenAPI规范生成API参考文档。
或者，按照本指南使用CLI开始使用Fern。
如果您正在迁移现有文档，Fern在企业计划中提供白手套迁移服务。请在这里联系我们。
您文档的所有配置都存放在fern文件夹中。通过使用入门模板或从零开始来创建fern文件夹。
将fern-api/docs-starter仓库作为您网站的模板：
fern-docs。您将看到一个基础网站，其中包含一个fern文件夹，该文件夹包含API定义、Markdown页面和配置文件。查看实时示例以了解入门模板发布后的外观。您可以使用这些文件测试Fern的功能，或用您自己的文件替换它们。
您将在项目中看到一个新的fern文件夹，其中包含以下配置文件（但没有其他Markdown或API定义文件）：
配置两个设置（这些值不必匹配）：
fern.config.json中：在Fern系统中标识您的组织（包括Fern控制台）docs.yml中：确定您的文档发布位置两个值都只能使用字母数字字符、连字符和下划线。
现在您有了一个基础文档网站，您可以通过添加教程、生成API参考文档或微调品牌来自定义它。（或跳到预览和发布。）
创建Markdown (.mdx) 文件并填写内容。阅读Markdown基础知识文档了解更多信息。
Fern在MDX文件中支持GitHub风格Markdown (GFM)，无需插件。您还可以创建可重用片段以在多个页面间共享内容。
在您的docs.yml文件中引用新页面。您可以在章节内引用Markdown页面，也可以作为独立页面引用。
如果您克隆了入门模板，您已经有一个包含示例API定义的openapi.yaml文件。如果您从零开始，请添加您的OpenAPI规范：
在docs.yml文件中引用您的API定义以生成API参考文档：
在docs.yml文件中配置您网站的所有品牌设置，如logo、颜色和字体。
在发布之前，在本地开发环境中预览您的更改或生成可共享的预览链接。
运行具有热重载功能的本地开发服务器。当您编辑Markdown和OpenAPI文件时，您的文档将自动更新：
入门模板还包含一个GitHub Actions工作流，可以自动为拉取请求生成预览链接。请参阅使用GitHub Actions自动化了解设置详情。
现在您的文档已上线，探索这些功能来进一步增强它们。