跳转到主要内容
使用 docs.json 文件中的这些设置来控制搜索引擎如何索引你的文档、搜索结果中显示的元数据、搜索栏的行为，以及页面是否显示最后修改时间戳。

​
设置

​
description

类型： string 文档站点的描述，用于 SEO 和 AI 索引。它会出现在搜索引擎结果中，AI 工具使用它来理解你站点的用途。
docs.json

​
seo

类型： object 搜索引擎索引和元数据设置。
​
"navigable" | "all"
指定搜索引擎应索引哪些页面。
  • navigable—仅索引包含在 docs.json 导航中的页面。默认为此值。
  • all—索引项目中的每个页面，包括不在导航中的页面。
​
object
添加到每个页面的自定义 meta 标签。以键值对形式提供，其中每个键是 meta 标签名称，值是其内容。有关可用选项，请参阅常见 meta 标签参考。
​
array
作用范围限定为某个文件夹的 meta 标签。使用它可以为一部分页面（例如版本化文档或特定的产品区域）应用不同的标签，而无需在每个页面的 frontmatter 中重复设置。每个条目包含：
  • path：相对于文档根目录的文件夹路径，例如 guides/v2，开头和结尾都不能有斜杠。将应用于该文件夹下的每个页面。每个路径只能出现一次。
  • metatags：以键值对形式提供的 meta 标签，将添加到 path 下的每个页面。值必须是非空字符串。
优先级从低到高依次为：seo.metatags、匹配的 seo.paths 条目（当页面位于多个条目下时，较长的路径优先于较短的路径），最后是页面的 frontmatter。路径与页面 URL 进行匹配，因此语言文件夹中的翻译页面需要单独的条目。例如，guides/v1 不会应用于 zh/guides/v1。Mintlify 会忽略 seo.paths 条目中的 canonical 键。请在 seo.metatags 中设置站点级规范 URL，或在 frontmatter 中设置单个页面的规范 URL。
​
object
用作每个页面所发出结构化数据中发布者实体的组织。所有字段均为可选。省略时，Mintlify 会根据你的站点名称、文档 logo 和站点 URL 推导组织。
  • id—用于在各页面中标识你的组织的稳定 @id URL，例如 https://example.com/#organization。默认值为 <站点来源>/#organization。
  • name—组织名称。默认值为站点名称。
  • legalName—注册的法定名称。
  • url—组织主页的规范 URL。
  • logo—在结构化数据中使用的规范 logo URL。默认值为文档 logo。
  • sameAs—官方主页 URL 数组，例如 X、LinkedIn 或 GitHub。
docs.json
类型： object 搜索栏显示设置。
​
string
搜索栏为空时显示的占位符文本。
docs.json

​
metadata

类型： object 全局应用于所有页面的页面级元数据设置。
​
boolean
在所有页面上显示最后修改日期。启用后，每个页面都会显示其内容最后修改的日期。默认为 false。你可以使用 timestamp frontmatter 字段为单个页面覆盖此设置。详情请参阅页面。
docs.json

​
示例

docs.json

相关主题

从 Document360 迁移从 Docusaurus 迁移从 Fern 迁移