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
预约演示登录免费开始
在本页
  • 2026年5月28日
  • Scope search by product or version
  • 2026年5月19日
  • Markdown rendering for API components
  • 2026年5月14日
  • CLI link checker
  • 2026年5月4日
  • Custom robots.txt
  • Multi-source docs
  • 2026年5月1日
  • API 目录发现
  • Prompt 组件上的自定义 URL 操作
  • 2026年4月29日
  • 重新设计的动态 OG 图片
  • 2026年4月27日
  • 全局主题
  • 2026年4月24日
  • "连接到 Claude Code" 页面操作
  • 2026年4月23日
  • 在合并时清理 GitHub Actions 预览部署
  • 2026年4月22日
  • 合并时清理 GitLab 预览部署

Changelog


May 28, 2026
May 28, 2026

May 19, 2026
May 19, 2026

May 14, 2026
May 14, 2026

May 4, 2026
May 4, 2026

May 1, 2026
May 1, 2026

April 29, 2026
April 29, 2026

April 27, 2026
April 27, 2026

April 24, 2026
April 24, 2026

April 23, 2026
April 23, 2026

April 22, 2026
April 22, 2026

较旧的帖子

下一个

Scope search by product or version

You can now control how search results are ranked and filtered for sites with multiple products or versions using the new settings.search object in docs.yml.

  • prioritize-current-product boosts results from the current product higher in the ranking without hiding other products.
  • default-filter-by-current-product auto-selects the current product as a facet filter so only current-product results appear by default.

These options can be used independently or together.

Read the docs

Markdown rendering for API components

Interactive API components now render as fenced code blocks and structured content in your site’s Markdown output. AI agents consuming your docs via .md URLs, llms.txt, or llms-full.txt receive the full request and response examples without parsing HTML, reducing content disparity between the rendered page and its Markdown representation.

This applies to the following components:

  • <EndpointRequestSnippet>
  • <EndpointResponseSnippet>
  • <EndpointSchemaSnippet>
  • <RunnableEndpoint>
  • <WebhookPayloadSnippet>
  • <Schema>
  • <SchemaSnippet>
Read the docs

CLI link checker

You can now check for broken links on your live documentation site directly from the Fern CLI with fern docs link check. The command scrapes every page on your published site, checks all internal and external links, and reports broken (404) and blocked (403) URLs along with the source pages where they appear.

$fern docs link check --url https://buildwithfern.com/learn
$fern docs link check --url https://elevenlabs.io/docs

This complements the existing broken-links rule in fern check, which validates internal links against your local YAML navigation tree. Use fern docs link check after publishing to catch live 404s and broken external URLs that local validation can’t detect.

Read the docs

Custom robots.txt

You can now serve your own robots.txt at the root of your documentation site by pointing agents.robots-txt at a file in your repo. Use this to opt in or out of specific AI crawlers like GPTBot or ClaudeBot, gate sensitive sections from indexing, or signal training and search preferences with the Cloudflare Content Signals Policy. Your file is served verbatim at /robots.txt, and Fern appends a managed block disallowing internal API routes after your content.

docs.yml
1agents:
2 robots-txt: ./robots.txt
Read the docs

Multi-source docs

Multi-source docs lets each team publish independently to a shared custom domain — for example, docs.nvidia.com spans sub-paths like /nvcf, /brev, and /aiperf, each owned by a different product team and repository.

Set multi-source: true on the instance and reference a global theme for consistent branding across repositories.

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
Read the docs

API 目录发现

AI 代理、MCP 客户端和 API 目录爬虫现在可以自动发现您的 API。每个 Fern Docs 站点都会暴露一个基于标准的(RFC 9727)/.well-known/api-catalog 端点,该端点从您可见的 API 参考导航生成。

阅读文档

Prompt 组件上的自定义 URL 操作

您现在可以将 <Prompt> 操作指向任何 AI 工具,而不仅仅是 Cursor、Claude 和 ChatGPT。将读者引导到 Perplexity、您自己的内部 AI 助手或任何其他 URL。

生成 TypeScript SDK
从我的 OpenAPI 规范生成 TypeScript SDK。请遵循 [TypeScript SDK 快速开始](https://buildwithfern.com/learn/sdks/generators/typescript/quickstart.md)。
Markdown
1<Prompt
2 title="生成 TypeScript SDK"
3 actions={[
4 { label: "在 Perplexity 中打开", url: "https://www.perplexity.ai/search?q={prompt}", icon: "magnifying-glass" },
5 "cursor"
6 ]}
7>
8从我的 OpenAPI 规范生成 TypeScript SDK。请遵循 [TypeScript SDK 快速开始](https://buildwithfern.com/learn/sdks/generators/typescript/quickstart.md)。
9</Prompt>
阅读文档

重新设计的动态 OG 图片

动态 OG 图片采用全新布局,可对 logo 变体、文本和背景颜色,以及显示哪些元素(章节、描述、URL、渐变)进行精细控制。

docs.yml
1metadata:
2 og:dynamic: true
3 og:dynamic:background-image: ./images/og-background.png
4 og:dynamic:text-color: "#1a1a1a"
5 og:dynamic:background-color: "#ffffff"
6 og:dynamic:logo-color: dark
7 og:dynamic:show-logo: true
8 og:dynamic:show-section: true
9 og:dynamic:show-description: true
10 og:dynamic:show-url: true
11 og:dynamic:show-gradient: true
阅读文档

全局主题

在单个控制仓库中定义您的文档品牌,并在多个网站之间共享。使用 fern docs theme CLI 命令导出、上传和管理主题,然后在任何子仓库的 docs.yml 中通过 global-theme 属性按名称引用主题。

阅读文档

“连接到 Claude Code” 页面操作

启用了 Ask Fern 的 Fern Docs 网站现在会在现有页面操作旁显示”连接到 Claude Code”按钮。点击按钮会复制一个 claude mcp add 命令。读者可以将其粘贴到终端中,以将您网站的 MCP 服务器注册到 Claude Code。

此操作默认启用,可以通过在 docs.yml 中设置 page-actions.options.claude-code: false 来关闭。

阅读文档

在合并时清理 GitHub Actions 预览部署

GitHub Actions 预览工作流 现在有一个可选的配套 cleanup-preview.yml 工作流,可以在 PR 合并后删除拉取请求的预览部署,这样过期的预览就不会留存。

要采用此工作流,请在现有预览工作流旁边添加 .github/workflows/cleanup-preview.yml。

阅读文档

合并时清理 GitLab 预览部署

更新的 GitLab CI/CD 流水线现在包含一个 cleanup_preview 阶段,在合并请求合并到默认分支后删除该 MR 的预览部署,避免陈旧的预览残留。

要采用此工作流程,请用更新的版本替换您的 .gitlab-ci.yml 文件。

阅读文档