.mdx 或 .md 任一文件类型。我们推荐使用 MDX，它将 Markdown 与 React 组件结合起来，以创建丰富的交互式文档。纯 Markdown（.md）可以加快从其他平台的迁移，但切换到 MDX 可以启用更多功能。
页面 metadata
--- 包裹的 YAML metadata。该 metadata 用于控制页面的呈现与行为。
所有 frontmatter 字段都是可选的。如果省略 title，Mintlify 会根据文件路径自动生成一个标题。对于不需要自定义 metadata 的页面，你可以完全省略 frontmatter 块。
使用 frontmatter 可以控制：
- 页面标题和说明
- 侧边栏标题、图标和标签
- 页面布局
- SEO（搜索引擎优化）meta 标签
- 自定义 metadata
string
显示在导航和浏览器标签页中的页面标题。如果省略，Mintlify 会根据路径生成标题。路径的最后一段会作为标题，其中的短横线和下划线会被替换为空格，且首字母会大写。例如，
guides/getting-started.md 会变为 入门。string
对本页面内容的简要说明。显示在标题下方，并提升 SEO。
string
显示在侧边栏导航中的短标题。
string
要显示的图标。选项：
- Font Awesome icon 名称
- Lucide icon 名称
- Tabler icon 名称
- 单个 emoji（例如
💡或🚀） - 指向外部托管图标的 URL
- 项目中图标文件的路径
string
仅适用于 Font Awesome 图标，用于指定图标样式。选项：
regular、solid、light、thin、sharp-solid、duotone、brands。string
显示在侧边栏中页面标题旁的标签。
设为
true 可将页面从侧边栏导航中移除。用户仍可通过其 URL 访问该页面，但搜索引擎不会对其进行索引。要使页面重新可见，请完全移除此字段。不要将其设置为 false，因为这会导致未定义的行为。详情参见隐藏页面。boolean
设为
true 可将该页面从站点搜索、站点地图、搜索引擎索引和 AI 助手 context 中排除。该页面在导航中仍然可见。详情参见停用索引。所有在 frontmatter 中包含 hidden: true 的页面都会自动获得 noindex: true。boolean
默认值:"true"
默认值为
true。除非显式关闭，否则页面都是可搜索的。设为 false 可将页面从文档站点的搜索结果和 AI 助手 context 中排除，同时保留外部搜索引擎对其的索引，并将其列入站点地图。该页面在导航中仍然可见。详情参见从搜索中排除页面。number
按此倍数放大页面在站内搜索中的排名。使用大于
1 的值可优先显示该页面，使用介于 0 和 1 之间的值可降低其优先级。详情参见 搜索加权。当 searchable: false 时，boost 无效，因为该页面不会出现在站内搜索结果中。boolean
设为
true 可在页面标题旁显示“deprecated”标签。可用它标记过时内容或旧版功能，同时保持页面可访问。设为
true 可隐藏页面底部的上一页/下一页导航链接。适用于落地页或参考页等不需要顺序导航的独立页面。boolean
设为
true 可隐藏侧边栏中页面标题旁的 HTTP 方法标记（如 GET 或 POST）。适用于希望侧边栏外观更简洁的 API 页面。object
为该页面覆盖站点级的上下文菜单。接受与
docs.json 中 contextual 字段相同的 options 数组和 display 值。省略该字段即可继承全局配置，将 options: [] 设为空数组则可在该页面禁用上下文菜单。string
任意有效的 YAML frontmatter。例如：
product: "API" 或 version: "1.0.0"。Example YAML frontmatter
页面模式
mode 设置控制页面的布局。
默认
宽屏
<Panel> 组件以及 API 请求和响应示例。对于没有任何标题的页面，或当你希望利用额外的横向空间时，它很实用。
自定义
Frame
居中
助手
API 页面
api 或 openapi），即可创建交互式 API 操作台。
外部链接
url metadata 直接链接到外部站点。
搜索引擎优化
含有冒号的元标签一定要使用引号括起来。
内部搜索关键词
keywords，帮助用户在搜索结果中发现特定页面。这些关键词不会出现在页面内容中。如果用户搜索这些关键词，该页面会出现在搜索结果中。
最后修改时间
metadata.timestamp，即可在所有页面显示“最后修改于 [日期]”时间戳。
docs.json
- 页面上设置的 frontmatter 字段
lastUpdatedDate（如已设置）。 - 对于由 GitHub 或 GitLab 支持的项目，最后一次修改页面源文件的 Git 提交日期。
- 最近一次部署的时间戳。
lastUpdatedDate。当 Git 历史无法反映内容的实际修改时间时（例如从其他系统导入或同步的内容），可使用该字段。
lastUpdatedDate 字段。当 Git 提交历史无法反映内容的真实更新时间时（例如从其他系统同步而来的文档），这一字段非常有用。可使用纯日期值或 ISO 8601 时间戳。
lastUpdatedDate，其次使用最后一次 Git 提交日期，最后使用最近一次部署的时间戳。当 lastUpdatedDate 的值无效或为空时，会回退为 Git 提交日期。
你可以在单个页面上使用 frontmatter 中的 timestamp 字段来覆盖全局时间戳设置。使用该字段可在特定页面上选择性地显示或隐藏时间戳。
timestamp 设置为 true，即使全局设置为 false，该页面也始终会显示时间戳。反之，如果设置为 false，即使全局设置为 true，该页面也会隐藏时间戳。