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

​
设置

​
description

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

​
seo

类型： object 搜索引擎索引和元数据设置。
​
seo.indexing
"navigable" | "all"
指定搜索引擎应索引哪些页面。
  • navigable — 仅索引包含在 docs.json 导航中的页面。默认为此值。
  • all — 索引项目中的每个页面，包括不在导航中的页面。
​
seo.metatags
object
添加到每个页面的自定义 meta 标签。以键值对形式提供，其中每个键是 meta 标签名称，值是其内容。有关可用选项，请参阅常见 meta 标签参考。
​
seo.organization
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 搜索栏显示设置。
​
search.prompt
string
搜索栏为空时显示的占位符文本。
docs.json

​
metadata

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

​
示例

docs.json