Docs 站点 Frontmatter

Docs 站点的 Frontmatter 字段定义与文件组织方式。

251 字1 分钟

文件组织

Docs 按目录树组织，侧边栏由 _meta.json 控制：

text

docs/├── _meta.json├── index.mdx├── architecture/│   ├── _meta.json│   ├── index.mdx│   ├── conventions.mdx│   └── frontmatter-guide.mdx└── projects/    ├── _meta.json    ├── blog/    │   ├── _meta.json    │   └── content.mdx    └── ...

_meta.json 机制

每个目录下的 _meta.json 控制侧边栏项的顺序和显示名称：

json

{  "index": "介绍",  "architecture": "架构指南",  "projects": {    "title": "项目文档",    "collapsed": true  }}

属性	类型	说明
`title`	`string`	侧边栏显示名称
`order`	`number`	排序权重，越小越靠前
`collapsed`	`boolean`	分组默认折叠

标题优先级：frontmatter title > _meta.json > 文件名。

Frontmatter 字段

DocsFrontmatterSchema 的完整定义：

字段	类型	必填	说明
`title`	`string`	✅	文档标题
`description`	`string`	—	SEO 描述
`cover`	`string`	—	封面图片 URL
`date`	`string`	—	创建日期 `YYYY-MM-DD`
`category`	`string`	—	分类名称
`tags`	`string[]`	—	标签数组
`updated`	`string`	—	最后更新日期

完整示例

yaml

---title: Frontmatter 用法与规范description: 详细说明 blog 和 docs 的 Frontmatter 字段定义与校验规则。date: "2026-07-06"category: 架构tags: Frontmatter, MDX---

概览

2 / 5

1.Blog 站点 Frontmatter 2.Docs 站点 Frontmatter 3.Blog 与 Docs 对比 4.Zod 校验规则 5.命名策略

Blog 站点 Frontmatter Blog 与 Docs 对比