用 .config.yml 配置目录级导航,以及设置页面/目录重定向。
目录配置与重定向
除了单篇 Markdown 的 frontmatter,你还可以在每个内容目录下放一个 .config.yml 文件,对整个目录做配置。
目录级导航
# content/docs/guide/.config.yml
navigation:
label: 指南
icon: book
description: 上手指南合集| 字段 | 类型 | 说明 |
|---|---|---|
navigation.title | string | 该目录在侧边栏的分组标题。 |
navigation.label | string | 备用标签。 |
navigation.description | string | 分组描述。 |
navigation.icon | string | 图标标识(由你的导航组件解释)。 |
navigation.hidden | boolean | 隐藏整个目录分组,子项也不显示。 |
navigation.flatten | boolean | 把子项提升到父级,不再生成这一层分组。 |
hidden:隐藏分组
navigation:
hidden: true目录从侧边栏消失,但目录内的页面仍可通过 URL 直接访问。
flatten:展开层级
navigation:
flatten: true子页面会被提升到上一级,不再单独出现「目录分组 → 子项」的两层结构,适合不想多一层嵌套的场景。
重定向
redirect 可以写在 .config.yml(目录级)或 Markdown frontmatter(页面级)中。
目录重定向
常用于把一个 collection 的根路径重定向到某篇具体文档:
# content/zh-CN/.config.yml
navigation:
hidden: true
redirect: /introduction访问 /zh-CN 会自动跳到 /zh-CN/introduction。
页面重定向
---
redirect: /zh-CN/guide/routing
---重定向目标的解析规则
- 绝对协议链接(如
https://...、mailto:...)原样保留。 - 站内相对路径会自动补上当前 collection 的 base 前缀。例如在 base 为
/zh-CN的 collection 里写redirect: /introduction,最终目标是/zh-CN/introduction。 - 如果目标已经带了 base 前缀,则不会重复添加。
框架会在构建期收集整个 workspace 的重定向规则;同一来源路径出现冲突的目标时会直接报错,帮助你尽早发现配置问题。