dumidumi
  • 指南
  • 配置项
  • 主题
  • 插件
⌘ K
介绍
什么是 dumi
基础
初始化
目录结构
约定式路由
页面渲染配置
写组件 demo
Markdown 增强
进阶
多语言
页面 Tab
移动端组件研发
自动 API 表格
其他
从 dumi 1.x 升级
常见问题
Open-source MIT Licensed | Copyright © 2019-present
Powered by self

目录结构

一个普通的、使用 dumi 做研发的组件库目录结构大致如下:

.
├── docs # 组件库文档目录
│ ├── index.md # 组件库文档首页
│ ├── guide # 组件库其他文档路由表(示意)
│ │ ├── index.md
│ │ └── help.md
├── src # 组件库源码目录
│ ├── Button # 单个组件
│ │ ├── index.tsx # 组件源码
│ │ ├── index.less # 组件样式
│ │ └── index.md # 组件文档
│ └── index.ts # 组件库入口文件
├── .dumirc.ts # dumi 配置文件
└── .fatherrc.ts # father-build 的配置文件,用于组件库打包

如果是单纯的文档站点、不包含组件源码,忽略上面的 src 目录结构即可。

注意,此处仅对目录结构做说明,如果要初始化一个 dumi 项目,建议直接使用 create-dumi 的脚手架进行创建。