Markdown 访问

Fern 会以干净的 Markdown 形式提供任意文档页面（包括 API 参考页面），方便代理高效消费您的内容。代理可以通过在页面 URL 后追加 .md 或 .mdx，或通过内容协商发送 Accept: text/markdown 请求头来获取源内容。结合 llms.txt，相比 HTML 可减少 90% 以上的 token 消耗。

展示页面底层 Markdown 的示例 — 例如，`https://buildwithfern.com/learn/docs/ai-features/markdown.md` 会显示本页面的 Markdown 源内容。

同一份 Markdown 在所有场景中通用——单页、llms.txt 和 llms-full.txt——并遵循相同的 <llms-only> 与 <llms-ignore> 内容控制规则。

每个页面在向 AI 代理输出 Markdown 时，都会自动附加一个默认的逐页指令，引导它们访问您的 .md URL、llms.txt 和 llms-full.txt。您可以在 docs.yml 中覆盖或停用该指令。该指令仅对代理可见，不会影响面向用户的文档展示。

访问受保护的文档

在启用了身份验证的站点上，无论代理请求的是单个页面、llms.txt 还是 llms-full.txt，每次请求都必须携带 JWT。请使用您的 Fern token 换取一个 JWT：

获取 JWT

$ curl https://docs.example.com/api/fern-docs/get-jwt \
>   -H "FERN_API_KEY: $FERN_TOKEN"
$ # → { "fern_token": "eyJ...", "roles": [] }

将返回的 JWT 作为 FERN_TOKEN 请求头附在后续请求上：

获取受保护内容

$ curl https://docs.example.com/platform/overview \
>   -H 'Accept: text/markdown' \
>   -H "FERN_TOKEN: $JWT"

JWT 的有效期为 30 天——请按需缓存并刷新。

用 Markdown 进行排错

直接查看 Markdown 也有助于排查布局问题。View as Markdown 按钮在每个页面上默认启用，可通过页面操作配置进行调整。

$	curl https://docs.example.com/api/fern-docs/get-jwt \
>	-H "FERN_API_KEY: $FERN_TOKEN"
$	# → { "fern_token": "eyJ...", "roles": [] }

$	curl https://docs.example.com/platform/overview \
>	-H 'Accept: text/markdown' \
>	-H "FERN_TOKEN: $JWT"