配置 SEO 元数据

用于 Open Graph 标签的网站名称。

在社交媒体预览中显示的标题。未设置时回退到页面的 title。

在社交媒体预览中显示的描述。未设置时回退到页面的 description、subtitle 或 excerpt。

文档的规范 URL。未设置时回退到页面的解析 URL。

内容的语言区域（例如 en_US）。无默认值；未设置时省略该标签。

文档网站的主机。用于设置元数据标签和站点地图等文档的规范 URL。默认为 instances 中定义的 URL。

在社交媒体预览中显示的图片。推荐尺寸为 1200x630 像素。无默认值；未设置时省略该标签。

Open Graph 图片的宽度（像素）。仅在设置 og:image 时应用。

Open Graph 图片的高度（像素）。仅在设置 og:image 时应用。

公司 logo 的 URL。无默认值；未设置时省略该标签。

当为 true 时，为没有设置自定义 og:image 的页面启用动态 OG 图片生成。任何站点级的 og:image 和 twitter:image 仍然应用于首页；其他页面使用动态生成的图片。

动态生成的 OG 图片的自定义背景图片。可以是 URL 或相对文件路径。相对路径从设置此属性的 YAML 文件（例如 docs.yml）解析。设置时，此图片用作背景而不是纯色。无默认值；未设置时动态 OG 图片渲染时不使用背景图片。

将重要的视觉内容保持在安全区域内——四边都有 80px 内边距的中央区域。页面标题、描述、logo 和 URL 渲染在背景之上，因此安全区域外的任何艺术品可能会被覆盖或根据平台被裁剪。

覆盖动态生成的 OG 图片的文本颜色。接受任何有效的 CSS 颜色值（例如 "#1a1a1a"）。默认情况下，Fern 从您的主题（grayScale[11]）读取文本颜色。如果没有可用的主题颜色，则回退到深色模式的 #ffffff 或浅色模式的 #1a1a1a。必须与 og:dynamic:background-color 不同，以便文本保持可见。

覆盖动态生成的 OG 图片的背景颜色。接受任何有效的 CSS 颜色值（例如 "#ffffff"）。默认情况下，Fern 从您的主题读取背景颜色。如果没有可用的主题颜色，则回退到 #0A0A0A。

选择在动态生成的 OG 图片中渲染的 logo 变体。接受 dark 或 light，匹配 docs.yml 中顶级 logo: 设置下的相应条目。如果您的 docs.yml 只定义了一个 logo 变体，则无论此设置如何都使用该变体。当 og:dynamic:show-logo: false 时无效。

切换动态生成的 OG 图片中 logo 的可见性。当启用 og:dynamic 时默认为 true。

切换动态生成的 OG 图片中章节标题的可见性。章节标题来源于页面的导航面包屑。当启用 og:dynamic 时默认为 true。

切换动态生成的 OG 图片中页面描述的可见性。描述从页面的前置字段（description、subtitle 或 excerpt）中提取。当启用 og:dynamic 时默认为 true。

切换动态生成的 OG 图片中页面 URL 的可见性。当启用 og:dynamic 时默认为 true。

切换动态生成的 OG 图片中强调色渐变覆盖的可见性。渐变使用您的强调色。当启用 og:dynamic 时默认为 true。

在 Twitter Card 预览中显示的标题。未设置时回退到 og:title（然后回退到页面标题）。

在 Twitter Card 预览中显示的描述。未设置时回退到 og:description（然后回退到页面描述）。

您公司的 Twitter 用户名。无默认值；未设置时省略该标签。

在 Twitter Card 预览中显示的图片。未设置时回退到 og:image。

您网站的 Twitter 用户名。无默认值；未设置时省略该标签。

Twitter Card 类型。选项有 summary、summary_large_image、app 或 player。

设置时，文档头部的 <title /> 标签将使用此值而不是 title 属性。例如，您的 title 可能是”快速开始”（在侧边栏和 H1 中显示），而 headline 可能是”快速开始 | PlantStore API 文档”，为搜索引擎提供更多上下文。如果未设置，Fern 使用 title 并附加您的站点名称。

覆盖此页面的规范 URL。必须是包含协议的完整 URL（例如 https://buildwithfern.com/learn/docs/content/frontmatter）。未设置时默认为页面的解析 URL。

与页面相关的逗号分隔关键词（例如 plants, garden, nursery）。仅接受逗号分隔的字符串，不接受数组。无默认值；未设置时省略该标签。

内容分享时应显示的网站名称。回退到 docs.yml 中的站点级 metadata.og:site_name。

内容分享时应显示的页面标题。未设置时回退到页面的 title。

内容分享时应显示的页面描述。未设置时回退到页面的 description、subtitle 或 excerpt。

页面的 URL。未设置时回退到页面的解析 URL。

内容分享时显示的图片 URL。回退到 docs.yml 中的站点级 metadata.og:image。

图片的宽度（像素）。无默认值；仅在设置 og:image 时使用。

图片的高度（像素）。无默认值；仅在设置 og:image 时使用。

页面的语言区域，通常格式为 language_TERRITORY（例如 en_US）。回退到 docs.yml 中的站点级 metadata.og:locale。

内容分享时显示的 logo 图片 URL。回退到 docs.yml 中的站点级 metadata.og:logo。

在推文中应显示的页面标题。未设置时回退到 og:title（然后回退到页面标题）。

在推文中应显示的页面描述。未设置时回退到 og:description（然后回退到页面描述）。

页面创建者或站点的 Twitter 用户名。回退到 docs.yml 中的站点级 metadata.twitter:handle。

在推文中显示的图片 URL。未设置时回退到 og:image。

您网站的 Twitter 用户名。回退到 docs.yml 中的站点级 metadata.twitter:site。

页面的 URL。未设置时回退到 og:url（然后回退到页面 URL）。

在 Twitter 上分享时使用的卡片类型。选项：summary、summary_large_image、app、player。

如果为 true，搜索引擎不会索引该页面，并且会从 llms.txt 端点中排除。

如果为 true，搜索引擎不会关注页面上的任何链接。