网站级别设置

用作选项卡标题的字符串。

为您的网站设置自定义徽标。了解更多关于logo 配置的信息。

网站图标的相对文件路径。路径相对于设置它的 YAML 文件（例如 docs.yml）。

配置 primaryAccent 和 background 颜色。了解更多关于colors 配置的信息。

您想要配置为永久重定向到另一个路径的路径数组。了解更多关于redirects 配置的信息。

您想要包含作为号召性用语的链接的名称和 URL 数组。了解更多关于navbar-links 配置的信息。

设置在每个页面后显示的自定义背景图像。了解更多关于background-image 配置的信息。

自定义文档网站中使用的字体。了解更多关于typography 配置的信息。

自定义文档网站的布局。了解更多关于layout 配置的信息。

自定义文档网站的设置。了解更多关于settings 配置的信息。

为您的文档网站创建着陆页。了解更多关于landing-page 配置的信息。

设置 API 参考中代码片段显示的默认语言。

选项包括：typescript、python、java、go、ruby、csharp、php、swift、curl

配置文档网站的 SEO 元数据。了解更多关于metadata 配置的信息。

应用于此网站的全局主题的名称。CLI 在发布时从 Fern 的注册表获取命名主题，并将其品牌字段（徽标、颜色、字体、布局、CSS、JS 等）合并到本地 docs.yml 中。使用此功能在多个文档网站间共享一致的视觉标识。

自定义 React 组件文件（TSX 或 JSX）的路径，用于替换 Fern 的默认页头。组件必须有默认导出。了解更多关于自定义页头和页脚组件的信息。

自定义 React 组件文件（TSX 或 JSX）的路径，用于替换 Fern 的默认页脚。组件必须有默认导出。了解更多关于自定义页头和页脚组件的信息。

配置一个或多个文档网站。

部署 Fern 文档的 URL。必须包含后缀 docs.buildwithfern.com。

托管文档的自定义域名。了解更多关于设置自定义域名的信息。

如果指定，会在每个页面底部添加”编辑此页面”链接，该链接指向给定的公共 GitHub 仓库。您可以选择设置 launch 目标来控制链接的跳转位置。了解更多关于edit-this-page 配置的信息。

指定此实例服务的受众（例如，内部开发者、测试用户、公共客户）。

您可以使用受众来控制每个文档实例中显示哪些版本和产品，从而为不同用户群体创建单独的网站。当内容的受众标签与实例受众匹配时，内容会被包含。没有受众标签的内容默认包含。了解更多关于为产品和/或版本配置实例受众的信息。

当为 true 时，CLI 使用基础路径感知发布，以便多个独立仓库可以使用不同基础路径发布到同一自定义域名。启用此功能时，url 和 custom-domain 必须共享相同的基础路径。了解更多关于多源文档的信息。

用于链接、按钮和高亮文本等交互元素的主要品牌色。 为浅色和深色模式配置不同的颜色以确保适当的对比度和可见性。

所有文档页面的主要背景色。选择与文本形成良好对比 并与您的品牌色互补的颜色。深色模式颜色应减少眼部疲劳。

用于分割线、元素边框和视觉分隔符。选择能创造 清晰边界但不太突出的微妙颜色。

导航侧边栏的背景色。指定时，右侧包含 1px 边框。 如果省略，侧边栏使用透明背景且无边框。

顶部导航页头的背景色。指定时，底部包含 1px 实线边框。 如果省略，页头使用透明背景和微妙的渐变边框。

卡片、代码块和其他容器元素的背景色。应该与主要背景 稍有不同，以创建视觉层次同时保持可读性。

用户点击徽标时会跳转到的 URL。通常是您公司的主页或应用程序。

深色模式徽标文件的路径，相对于设置它的 YAML 文件（例如 docs.yml）。建议使用 SVG 格式以获得最佳质量。示例：assets/images/logo-dark.svg

浅色模式徽标文件的路径，相对于设置它的 YAML 文件（例如 docs.yml）。建议使用 SVG 格式以获得最佳质量。示例：assets/images/logo-light.svg

在徽标图像右侧显示的文本。这对于在徽标旁边添加”Docs”或”API”等标签很有用。

徽标的自定义高度（像素）。如果默认高度不适合您的设计，请使用此选项调整徽标大小。

您要重定向的相对路径（例如，/old-path）。必须是相对路径，而不是绝对 URL。不能包含搜索参数（例如，?key=value）。匹配前会对末尾斜杠进行归一化，因此 /old-path/ 和 /old-path 等价。请与所重定向 URL 的大小写保持一致。

您要路由到的路径。可以是内部路径（/new-path）或外部 URL（https://example.com）。外部 URL 必须包含完整地址，包括 https。

默认使用 308 状态码指示客户端和搜索引擎永久缓存重定向。只有在需要使用 307 状态码的临时重定向时才设置为 false，这不会被缓存。

outlined、minimal、filled、github 或 dropdown 中的一个。此值控制按钮的样式。

点击按钮后的 URL。示例：https://buildwithfern.com/book-demo

GitHub 仓库的 URL。类似于 href，但专门用于 GitHub 仓库链接。当 type 设置为 github 时使用此字段。示例：https://github.com/example-company/fern

按钮内的文本。

当为 true 时，按钮的边框半径将完全圆角。

按钮中使用的图标。此图标将出现在文本内容的左侧。

Icons can be in three formats:

• Font Awesome icons: Use icon names like fa-solid fa-rocket. Pro and Brand Icons from Font Awesome are supported.
• Custom image files: Use relative paths to image files (e.g., ./assets/icons/my-icon.svg or ../assets/icons/my-icon.png). Paths are relative to the YAML file where the icon is referenced (e.g., docs.yml). For example, if you set an icon in fern/products/my-product.yml, the path ./assets/icon.svg resolves to fern/products/assets/icon.svg. If you set it in fern/docs.yml, the same path resolves to fern/assets/icon.svg.
• Inline SVG: Provide an SVG string wrapped in quotes (e.g., "<svg>...</svg>").

按钮中使用的图标。此图标将出现在文本内容的右侧。

Icons can be in three formats:

• Font Awesome icons: Use icon names like fa-solid fa-rocket. Pro and Brand Icons from Font Awesome are supported.
• Custom image files: Use relative paths to image files (e.g., ./assets/icons/my-icon.svg or ../assets/icons/my-icon.png). Paths are relative to the YAML file where the icon is referenced (e.g., docs.yml). For example, if you set an icon in fern/products/my-product.yml, the path ./assets/icon.svg resolves to fern/products/assets/icon.svg. If you set it in fern/docs.yml, the same path resolves to fern/assets/icon.svg.
• Inline SVG: Provide an SVG string wrapped in quotes (e.g., "<svg>...</svg>").

默认情况下，filled 按钮的 rightIcon 设置为 arrow-right。

指定在何处打开链接的 URL。对于典型的文档网站，链接可以在同一标签页（_self）或新标签页（_blank）中打开。对于嵌入在仪表板或 iframe 中的文档，链接可以在父框架（_parent）或最顶层框架（_top）中打开。

当 type 设置为 dropdown 时在下拉菜单中显示的项目。

为链接显示的文本。

链接指向的 URL。

在文本左侧显示的 Font Awesome 图标。

在文本右侧显示的 Font Awesome 图标。

当为 true 时，链接将具有完全圆角边框。

指定在何处打开链接的 URL。

您的 GitHub 仓库或组织的 URL。

您的 Slack 社区或工作空间的 URL。

您的 X（原 Twitter）档案的 URL。

您的 Twitter 档案的 URL。使用 footer-links.x 获得新的 X 品牌。

您的 LinkedIn 公司页面或档案的 URL。

您的 YouTube 频道的 URL。

您的 Instagram 档案的 URL。

您的 Facebook 页面的 URL。

您的 Discord 服务器邀请的 URL。

您的 Hacker News 档案的 URL。

您的 Medium 出版物或档案的 URL。

您的主网站或主页的 URL。

浅色模式背景图像的相对文件路径。路径相对于设置它的 YAML 文件（例如 docs.yml）。

深色模式背景图像的相对文件路径。路径相对于设置它的 YAML 文件（例如 docs.yml）。

用于所有正文的字体，包括段落、列表和一般内容。 为了获得最佳性能，请使用 WOFF2 格式。

用于标题、题目和其他突出文本元素的字体。如果您喜欢统一的外观， 可以与正文字体相同。支持不同标题级别的多种字重。

用于代码块和内联代码的字体。建议使用等宽字体以获得更好的代码可读性。 热门选择包括 JetBrains Mono、Fira Code 和 Source Code Pro。

字体的名称。默认为生成的名称，该名称将用于在最终注入的 CSS 中引用您的自定义字体。

字体文件的路径，相对于设置它的 YAML 文件（例如 docs.yml）。当您只有一个字体文件时使用此选项。对于多个字体文件（如粗体、斜体等的单独文件），请使用 paths。

字体的字重。可以是数字（400、700）或可变字体的范围（400 700）。 常见值：400（正常）、700（粗体）。

字体样式，可以是”normal”或”italic”。如果未指定，默认为”normal”。

特定字重的字体文件列表。列表中的每个元素包含 path、weight 和 style 属性。

设置页头的高度。默认为 4rem（64px）。有效选项为 {number}rem 或 {number}px。

设置文档布局的最大宽度，包括侧边栏和内容。默认为 88rem（1408px）。 有效选项为 {number}rem、{number}px 或 full。

设置 Markdown 文章内容的最大宽度。默认为 44rem（704px）。 有效选项为 {number}rem 或 {number}px。

设置桌面模式下侧边栏的宽度。默认为 18rem（288px）。有效选项为 {number}rem 或 {number}px。

设置搜索栏的位置。可以是 header、sidebar 或 header-tabs（将搜索栏放在页头但在选项卡行）之一。

设置选项卡的位置。可以是 header 或 sidebar 之一。

设置产品和版本切换器的位置。可以是 header 或 sidebar 之一。

设置 Markdown 内容的对齐方式。可以是 center 或 left 之一。 默认为 center。

如果设置为 true，页头将不会呈现。相反，徽标将作为侧边栏的一部分呈现， 1px 边框将分隔侧边栏和内容。

如果设置为 true，页面底部的导航链接（上一页、下一页）将不会呈现。这可以通过页面 frontmatter在单个页面基础上覆盖。

如果设置为 true，反馈表单将不会呈现。这可以通过页面 frontmatter在单个页面基础上覆盖。

如果设置为 true，在移动设备和平板电脑视口（在 xl 断点以下）的页头下方显示粘性目录栏。该栏显示滚动进度指示器和当前标题，点击时展开为完整目录。

仅适用于使用guide 和 overview 布局的页面。当页面的标题少于两个或在页面 frontmatter 中设置了 hide-toc: true 时，该栏会隐藏。

设置导航侧边栏的视觉样式。default 显示带有节标题和图标的完整侧边栏；minimal 显示没有装饰元素的更简洁、简化的侧边栏。

设置主要内容正文的视觉样式。default 使用平面背景；canvas 在内容区域周围添加微妙的卡片式容器。

配置导航选项卡。接受字符串（default 或 bubble）进行仅样式配置，或带有 style、alignment 和 placement 属性的对象进行完全控制。

当设置为字符串时，default 使用下划线选项卡，bubble 显示带有圆角药丸形背景的选项卡。

设置导航选项卡的视觉样式。default 使用下划线选项卡；bubble 显示带有圆角药丸形背景的选项卡。

当 placement 为 header 时设置选项卡的水平对齐方式。left 将选项卡左对齐；center 将其水平居中。当 placement 为 sidebar 时，对齐方式无效。

设置选项卡的位置。header 在顶部导航页头中显示选项卡；sidebar 在左侧侧边栏中显示它们。

当两者都设置时，优先于 layout.tabs-placement。当 layout.disable-header 设置为 true 时，此设置被忽略。

设置页面操作按钮的视觉样式。default 显示单独的图标按钮；toolbar 将操作分组为紧凑的水平工具栏。

设置页脚导航链接的视觉样式。default 显示带有标题和描述的完整上一页/下一页卡片；minimal 显示简单的文本链接。

设置产品切换器的视觉样式。default 显示下拉选择器；toggle 显示水平切换栏。

在搜索栏中显示的文本。

如果设置为 true，搜索栏将被禁用。如果您想使用自定义搜索解决方案，请使用此选项。

如果设置为 true，API Explorer 在直接向您的 API 发送请求时将绕过代理。

如果设置为 true，代码块将以深色模式显示，无论选择的主题如何。

控制搜索结果是否默认限定在用户当前的产品和版本范围内。

当设置为 false（默认值）时，搜索返回所有产品和版本的结果。当设置为 true 时，搜索 UI 会自动筛选结果以匹配用户当前浏览的产品和版本。用户可以从搜索 UI 中删除这些过滤器以扩大搜索范围。

控制 API 参考中 HTTP 片段的显示。默认情况下为所有语言启用 HTTP 片段。

• 设置为 false 以完全禁用 HTTP 片段
• 提供语言列表以仅为特定语言启用片段

1
# 仅为 Python 和 Ruby 启用
2
settings:
3
  http-snippets:
4
    - python
5
    - ruby

如果设置为 true，当用户导航到不存在的页面时，他们将被重定向到主页。

默认情况下，将显示 404 页面。

如果设置为 true，TypeScript 片段将在 API 参考中显示为 JavaScript 片段。

如果设置为 true，在analytics 配置中配置的所有分析集成将被禁用。这包括 Google Analytics 4、Google Tag Manager、PostHog 和您配置的任何其他分析提供商。

设置在所有文件夹导航中导出页面和节标题的默认方法。默认情况下（filename），标题从文件名导出。设置为 frontmatter 以使用每个文件的 frontmatter 中的 title 字段（如果未设置则回退到文件名）。各个文件夹可以使用每个文件夹的 title-source 设置覆盖此全局默认值。

如果设置为 true，在构建时将 ${ENV_VAR} 表达式替换为环境变量值。对于将 API 密钥、基础 URL 或版本号注入到文档中很有用。

1
连接到我们的 API：${API_BASE_URL}/v1
2
3
您的 API 密钥：${API_KEY}

替换在 Markdown/MDX 文件和 API 规范 (OpenAPI) 中有效。为避免与模板字面量冲突，JavaScript 文件被排除。

要输出字面 ${VAR}，请转义为 \$\{VAR\}。

要显示的默认页面操作。选项：copy-page、view-as-markdown、ask-ai、chatgpt、claude、claude-code、cursor、vscode。

启用时，显示允许用户将整个页面内容复制到剪贴板的按钮，便于共享或参考。要控制复制输出中出现的内容，请使用 <llms-ignore> 标签。

启用时，显示允许用户查看当前页面原始 Markdown 源代码的按钮。用户也可以通过在页面 URL 后附加 .md 查看 Markdown。要控制 Markdown 输出中出现的内容，请使用 <llms-ignore> 标签。

启用时，显示”Ask AI”按钮，允许用户使用 AI 支持的助手询问关于页面内容的问题。

控制”在 ChatGPT 中打开”按钮，该按钮将页面内容发送到 ChatGPT 进行进一步探索和问答。设置为 false 以隐藏它。

控制”在 Claude 中打开”按钮，该按钮将页面内容发送到 Claude 进行进一步探索和问答。设置为 false 以隐藏它。

控制”连接到 Claude Code”按钮，该按钮将 claude mcp add 命令复制到剪贴板，以便用户可以在 Claude Code 中注册文档网站的 MCP 服务器。当启用 Ask Fern 时默认显示。设置为 false 以隐藏它。

控制”连接到 Cursor”按钮，该按钮通过深链接在 Cursor 中安装文档网站的 MCP 服务器。当启用 Ask Fern 时默认显示。设置为 false 以隐藏它。

启用时，显示”在 VS Code 中打开”按钮，允许用户在 Visual Studio Code 中打开页面内容进行编辑和开发。需要启用 Ask Fern。

控制站点的 MCP 服务器端点。设置为 false 时，/_mcp/server 端点返回 404，其 URL 从 llms.txt 和代理提示中删除，连接到 Claude Code / 连接到 Cursor 按钮也会隐藏。适用于未经身份验证的 AI 代理会发现端点但无法访问的需要身份验证的站点。

自定义页面操作配置数组。每个自定义操作在页面操作菜单中显示为一个按钮。

为自定义操作按钮显示的标题。

在操作菜单中标题下方显示的可选帮助文本。

点击操作时要导航到的 URL。支持以下占位符：

• {slug}：当前页面的 slug（例如 getting-started/quickstart）
• {domain}：当前域名（例如 docs.example.com）
• {url}：当前页面的完整 URL（例如 https://docs.example.com/getting-started/quickstart）

为自定义操作显示的图标。

Icons can be in three formats:

• Font Awesome icons: Use icon names like fa-solid fa-rocket. Pro and Brand Icons from Font Awesome are supported.
• Custom image files: Use relative paths to image files (e.g., ./assets/icons/my-icon.svg or ../assets/icons/my-icon.png). Paths are relative to the YAML file where the icon is referenced (e.g., docs.yml). For example, if you set an icon in fern/products/my-product.yml, the path ./assets/icon.svg resolves to fern/products/assets/icon.svg. If you set it in fern/docs.yml, the same path resolves to fern/assets/icon.svg.
• Inline SVG: Provide an SVG string wrapped in quotes (e.g., "<svg>...</svg>").

当设置为 true 时，此自定义操作成为在页面操作区域中突出显示的默认操作。

如果您在自定义操作上设置了 default: true，请不要同时设置 page-actions.default 以避免冲突。

拥有文档仓库的 GitHub 组织。

包含您的 fern 文件夹的 GitHub 仓库名称。

您希望 GitHub 编辑器打开 PR 到的仓库分支。默认为 main。

控制”编辑此页面”按钮的行为。当设置为 dashboard 时，点击按钮会打开一个屏幕，用户可以在其中选择为该页面启动 Fern Editor 会话或直接前往 GitHub 中的源代码（最适合内部网站）。默认为 github，直接链接到 GitHub 上的文件（最适合面向公众的网站）。

着陆页的名称。

所需着陆页 Markdown 文件的相对文件路径。路径相对于设置它的 YAML 文件（例如 docs.yml）。

着陆页的 slug。默认为页面名称。

slug 也可以在着陆页 Markdown 文件的 frontmatter 中覆盖。

您的网站在 Open Graph 标签中的名称。

在社交媒体预览中显示的标题。

在社交媒体预览中显示的描述。

您文档的规范 URL。

在社交媒体预览中显示的图像。推荐尺寸为 1200x630 像素。

Open Graph 图像的宽度（像素）。