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

​
页面 metadata

每个页面都以 frontmatter 开始，即文件开头由 --- 包裹的 YAML metadata。该 metadata 用于定义页面的呈现与行为。 使用 frontmatter 可以控制：
  • 页面标题和说明
  • 侧边栏标题、图标和标签
  • 页面布局
  • SEO（搜索引擎优化）meta 标签
  • 自定义 metadata
​
string
必填
显示在导航和浏览器标签页中的页面标题。
​
string
对本页面内容的简要说明。显示在标题下方，并提升 SEO。
​
string
显示在侧边栏导航中的短标题。
​
string
要显示的 icon。选项：
​
string
Font Awesome 的图标样式。仅在使用 Font Awesome 图标时使用。选项：regular、solid、light、thin、sharp-solid、duotone、brands。
​
string
显示在侧边栏中页面标题旁的标签。
​
string
任意有效的 YAML frontmatter。例如：product: "API" 或 version: "1.0.0"。
Example YAML frontmatter

​
页面模式

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

​
默认

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

​
宽屏

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

​
自定义

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

​
Frame

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

​
居中

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

​
API 页面

在你的 frontmatter 中添加 API 规范（通过 api 或 openapi 字段），即可创建交互式 API 操作台。
进一步了解如何构建 API 文档。 在导航中使用 url metadata 直接链接到外部站点。

​
搜索引擎优化

大多数 SEO（搜索引擎优化）元标签会自动生成。你也可以手动设置 SEO 元标签，以提升站点的 SEO 表现、社交分享效果和浏览器兼容性。
含有冒号的元标签必须使用引号括起来。
有关完整的 SEO（搜索引擎优化）metadata 选项，请参阅 SEO。

​
内部搜索关键词

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

​
最后修改时间

在全局设置中启用 metadata.timestamp，即可在所有页面显示“最后修改于 [日期]”时间戳。
docs.json