dumi 约定式路由 vs 自定义路由

一、核心结论

• docDirs：普通文档从哪读
• atomDirs：组件 / 资产文档从哪读 & 怎么分组
• Frontmatter：控制导航展示
• routes：我不想按目录来

二、约定式路由

docDirs：普通文档

docDirs: ['docs']

• 读取 docs 下的 md / mdx
• 自动生成路由 + 侧边栏
• 路径 = 文件路径

atomDirs：组件文档

atomDirs: [
  { type: 'component', dir: 'src' },
];

• 用于组件 / hooks / utils 等“资产型文档”
• type 决定一级分类
• subType 可选，用于二级分组
• 常见于组件库文档

三、Frontmatter 控制导航

---
title: Button
order: 1
group: 基础组件
nav: 组件
---

字段	作用
title	显示名
order	排序
group	侧边栏分组
nav	顶部导航

四、自定义路由

当你 不想按目录结构生成路由 时用。

export default {
  routes: [
    { path: '/', component: '@/docs/index.md' },
    { path: '/guide', component: '@/docs/guide.md' },
    {
      path: '/custom/button',
      component: '@/src/Button/index.md',
    },
  ],
};

• 路径完全手写
• 写了 routes 就是手动接管
• 不再参与约定式规则