跳转到主要内容
每个页面对应一个 Markdown 文件。你可以为页面使用 .mdx 或 .md 任一文件类型。我们推荐使用 MDX，它将 Markdown 与 React 组件结合起来，以创建丰富的交互式文档。纯 Markdown（.md）可以加快从其他平台的迁移，但切换到 MDX 可以启用更多功能。

​
页面 metadata

每个页面都以 frontmatter 开始，即文件顶部由 --- 包裹的 YAML metadata。该 metadata 用于控制页面的呈现与行为。 使用 frontmatter 可以控制：
  • 页面标题和说明
  • 侧边栏标题、图标和标签
  • 页面布局
  • SEO（搜索引擎优化）meta 标签
  • 自定义 metadata
​
title
string
必填
显示在导航和浏览器标签页中的页面标题。
​
description
string
对本页面内容的简要说明。显示在标题下方，并提升 SEO。
​
sidebarTitle
string
显示在侧边栏导航中的短标题。
​
icon
string
要显示的 icon。选项：
​
iconType
string
仅适用于 Font Awesome 图标。图标的样式。选项：regular、solid、light、thin、sharp-solid、duotone、brands。
​
tag
string
显示在侧边栏中页面标题旁的标签。
​
hidden
boolean
设为 true 可将页面从侧边栏导航中移除。用户仍可通过其 URL 访问该页面，但搜索引擎不会对其进行索引。详情参见 Hidden pages。
​
noindex
boolean
设为 true 可阻止搜索引擎对该页面进行索引。详情参见 Disable indexing。所有在 frontmatter 中包含 hidden: true 的页面都会自动获得 noindex: true。
​
<custom>
string
任意有效的 YAML frontmatter。例如：product: "API" 或 version: "1.0.0"。
Example YAML frontmatter
---
title: "关于 frontmatter"
description: "Frontmatter 是控制页面显示和行为的 metadata"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NEW"
---

​
页面模式

通过 mode 设置控制页面的布局。

​
默认

如果未指定模式，则会使用带有侧边栏导航和目录的标准布局。 
---
title: "默认页面标题"
---

​
宽屏

宽屏模式会隐藏目录。对于没有任何标题的页面，或当你希望利用额外的横向空间时，它很实用。所有主题均支持宽屏模式。 
---
title: "宽页面标题"
mode: "wide"
---

​
自定义

自定义模式提供极简布局，只保留顶部导航栏。你可以将自定义模式视为一块空白画布，用于构建落地页或导航元素极少的自定义布局。所有主题都支持自定义模式。 
---
title: "自定义页面标题"
mode: "custom"
---
自定义模式页面上的 style 属性可能会在页面加载时引发布局偏移。为避免此问题，建议优先使用 Tailwind CSS 或自定义 CSS 来实现样式。

​
Frame

Frame 模式提供与自定义模式类似的布局，但保留侧边栏导航。使用此模式，可以在保持默认导航体验的同时使用自定义 HTML 和组件。仅 Aspen 和 Almond 主题支持 Frame 模式。 
---
title: "Frame 页面标题"
mode: "frame"
---

​
居中

居中模式会移除侧边栏和目录，并将内容居中呈现。对于更新日志或其他希望将重点放在内容上的页面，请使用居中模式。Mint 和 Linden 主题均支持居中模式。 
---
title: "居中页面标题"
mode: "center"
---

​
API 页面

在你的 frontmatter 中添加 API 规范（通过设置 api 或 openapi），即可创建交互式 API 操作台。 
---
openapi: "GET /endpoint"
---
进一步了解如何构建 API 文档。 在导航中使用 url metadata 直接链接到外部站点。 
---
title: "npm 包"
url: "https://www.npmjs.com/package/mint"
---

​
搜索引擎优化

Mintlify 会自动生成大多数 SEO（搜索引擎优化）元标签。你也可以手动设置 SEO 元标签，以自定义 SEO、社交分享和浏览器兼容性相关的配置。
含有冒号的元标签一定要使用引号括起来。
---
"twitter:image": "/images/social-preview.jpg"
---
有关完整的 SEO（搜索引擎优化）metadata 选项，请参阅 SEO。

​
内部搜索关键词

通过在 metadata 中提供 keywords，帮助用户在搜索结果中发现特定页面。这些关键词不会出现在页面内容中。如果用户搜索这些关键词，该页面会出现在搜索结果中。 
---
keywords: ['配置', '设置', '入门指南']
---

​
最后修改时间

在全局设置中启用 metadata.timestamp，即可在所有页面显示“最后修改于 [日期]”时间戳。
docs.json
"metadata": {
  "timestamp": true
}
你可以在单个页面上使用 frontmatter 中的 timestamp 字段来覆盖全局时间戳设置。使用该字段可在特定页面上选择性地显示或隐藏时间戳。 
---
title: "页面标题"
timestamp: false
---
如果将 timestamp 设置为 true，即使全局设置为 false，该页面也始终会显示时间戳。如果将 timestamp 设置为 false，即使全局设置为 true，该页面也会隐藏时间戳。