mintlify__docs/zh/organize/pages.mdx

---
title: "页面"
description: "配置页面 metadata、标题和 frontmatter 属性。"
keywords: ["tags", "tag", "frontmatter", "metadata", "layout"]
---

每个页面对应一个 Markdown 文件。支持 `.mdx` 和 `.md` 两种文件类型。我们推荐使用 MDX，它将 Markdown 与 React 组件结合起来，以创建丰富的交互式文档。也支持纯 Markdown（`.md`），以便更轻松地从其他平台迁移，但应尽量升级为 MDX 以获得完整功能。

<div id="page-metadata">
  ## 页面 metadata
</div>

每个页面都以 frontmatter 开始，即文件开头由 `---` 包裹的 YAML metadata。该 metadata 用于定义页面的呈现与行为。

使用 frontmatter 可以控制：

* 页面标题和说明
* 侧边栏标题、图标和标签
* 页面布局
* SEO（搜索引擎优化）meta 标签
* 自定义 metadata

<ResponseField name="title" type="string" required>
  显示在导航和浏览器标签页中的页面标题。
</ResponseField>

<ResponseField name="description" type="string">
  对本页面内容的简要说明。显示在标题下方，并提升 SEO。
</ResponseField>

<ResponseField name="sidebarTitle" type="string">
  显示在侧边栏导航中的短标题。
</ResponseField>

<ResponseField name="icon" type="string">
  要显示的 icon。

  选项：

  * [Font Awesome icon](https://fontawesome.com/icons) 名称
  * [Lucide icon](https://lucide.dev/icons) 名称
  * 指向外部托管图标的 URL
  * 项目中图标文件的路径
</ResponseField>

<ResponseField name="iconType" type="string">
  [Font Awesome](https://fontawesome.com/icons) 的图标样式。仅在使用 Font Awesome 图标时使用。

  选项：`regular`、`solid`、`light`、`thin`、`sharp-solid`、`duotone`、`brands`。
</ResponseField>

<ResponseField name="tag" type="string">
  显示在侧边栏中页面标题旁的标签。
</ResponseField>

<ResponseField name="<custom>" type="string">
  任意有效的 YAML frontmatter。例如：`product: "API"` 或 `version: "1.0.0"`。
</ResponseField>

```yaml Example YAML frontmatter wrap
---
title: "关于 frontmatter"
description: "Frontmatter 是控制页面显示和行为的 metadata"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NEW"
---
```

<div id="page-mode">
  ## 页面模式
</div>

通过 `mode` 设置控制页面的呈现方式。

<div id="default">
  ### 默认
</div>

如果未指定模式，则会使用带有侧边栏导航和目录的标准布局。

```yaml
---
title: "默认页面标题"
---
```

<div id="wide">
  ### 宽屏
</div>

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

```yaml
---
title: "宽页面标题"
mode: "wide"
---
```

<div id="custom">
  ### 自定义
</div>

自定义模式提供极简布局，除顶部导航栏外移除所有元素。它是一块空白画布，可用于创建登录页或其他希望尽量减少导航元素的个性化布局。自定义模式适用于所有主题。

```yaml
---
title: "自定义页面标题"
mode: "custom"
---
```

<Warning>
  在自定义模式页面上使用 `style` 属性可能会在页面加载时导致布局偏移。请改用 [Tailwind CSS 或自定义 CSS](/zh/customize/custom-scripts) 来避免此问题。
</Warning>

<div id="frame">
  ### Frame
</div>

Frame 模式提供与自定义模式类似的布局，但保留侧边栏导航。此页面模式在保持默认导航体验的同时，支持自定义 HTML 和组件。Frame 模式仅适用于 Aspen 和 Almond 主题。

```yaml
---
title: "Frame 页面标题"
mode: "frame"
---
```

<div id="center">
  ### 居中
</div>

居中模式会移除侧边栏和目录，并将内容居中呈现。对于更新日志或其他需要突出内容的页面，这非常有用。Mint 和 Linden 主题均支持居中模式。

```yaml
---
title: "居中页面标题"
mode: "center"
---
```

<div id="api-pages">
  ## API 页面
</div>

在你的 frontmatter 中添加 API 规范（通过 `api` 或 `openapi` 字段），即可创建交互式 API 操作台。

```yaml
---
openapi: "GET /endpoint"
---
```

进一步了解如何构建 [API 文档](/zh/api-playground/overview)。

<div id="external-links">
  ## 外部链接
</div>

在导航中使用 `url` metadata 直接链接到外部站点。

```yaml
---
title: "npm 包"
url: "https://www.npmjs.com/package/mint"
---
```

<div id="search-engine-optimization">
  ## 搜索引擎优化
</div>

大多数 SEO（搜索引擎优化）元标签会自动生成。你也可以手动设置 SEO 元标签，以提升站点的 SEO 表现、社交分享效果和浏览器兼容性。

<Note>
  含有冒号的元标签必须使用引号括起来。
</Note>

```yaml
---
"twitter:image": "/images/social-preview.jpg"
---
```

有关完整的 SEO（搜索引擎优化）metadata 选项，请参阅 [SEO](/zh/optimize/seo)。

<div id="internal-search-keywords">
  ## 内部搜索关键词
</div>

在 metadata 中提供 `keywords`，可提升特定页面在内置搜索中的可发现性。这些关键词不会作为页面内容显示，也不会出现在搜索结果列表中，但当用户搜索这些词时，该页面会作为匹配结果呈现。

```yaml
---
keywords: ['配置', '设置', '入门指南']
---
```

<div id="last-modified-timestamp">
  ## 最后修改时间
</div>

在[全局设置](/zh/organize/settings#metadata)中启用 `metadata.timestamp`，即可在所有页面显示“最后修改于 [日期]”时间戳。

```json docs.json
"metadata": {
  "timestamp": true
}
```

你可以在单个页面上使用 frontmatter 中的 `timestamp` 字段来覆盖全局时间戳设置。使用该字段可在特定页面上选择性地显示或隐藏时间戳。

```yaml
---
title: "页面标题"
timestamp: false
---
```

当本设置为 `true` 时，即使全局设置为 `false`，仍会显示时间戳。当本设置为 `false` 时，即使全局设置为 `true`，时间戳也会被隐藏。