Frontmatter

Frontmatter 是位于页面顶部的 YAML 数据区块，用于定义页面元数据并精细化控制导航、排序及其他全局行为。

---
title: 指南
weight: 10
hidden: false
isRoot: true
exclude: false
date: 2025-01-01
starryNight: true
---

核心字段说明

• title: 页面标题（映射至导航名称及 <title>）
• excerpt / description: 用于 Meta 标签的简短描述（别名属性，可任选其一）
• weight: 导航排序权重，数值越小排序越优先
• hidden: 在导航菜单中隐藏（/404 与 isRoot 默认隐藏）；被隐藏的页面依然可以通过直接访问 URL 正常渲染
• isRoot: 将 index.mdx 指定为当前子树的导航根节点
• exclude: 从 dev/build 流程中剔除；若在目录 index.mdx 中设置，将排除整个目录及其子项
• date: 当 weight 冲突时，作为次级排序依据
• lang: 语言选择器的显示名称；系统仅从各级目录的 index.mdx（包含根目录）中读取该字段
• langCode: HTML 标签 lang属性所使用的语言代码；系统仅从各级目录的 index.mdx（包含根目录）中读取
• starryNight: 页面级代码高亮配置覆盖（true/false/配置对象）

核心注意事项

• isRoot 属性仅在 index.mdx 页面中生效。
• isRoot 标记的页面默认在导航中隐藏；若需显式展示，请配合设置 hidden: false。
• 以 _ 或 . 开头的文件或目录将始终从导航树中剔除。
• Frontmatter 中的 starryNight 设置优先级高于全局配置及 CLI 参数。
• Frontmatter 解析基于 gray-matter 实现。

功能示例

• 隐藏板块
• 隐藏页面

多语言索引配置示例

仅需在各语言目录的 index.mdx 中配置 lang 及 langCode：

---
title: 简体中文
lang: 简体中文
langCode: zh
isRoot: true
hidden: true
---