dumi

基于 Umi、为组件开发场景而生的文档工具

开箱即用

考究的默认配置和约定式的目录结构,帮助开发者零成本上手,让所有注意力都能放在文档编写和组件开发上

高性能

有强大的 Umi 做底座,天生高性能、可扩展,且可使用 Umi 生态中的大部分插件

为组件开发而生

独特的 Markdown 扩展,可嵌入 Demo、可导入外部 Demo 甚至插入自定义 React 组件,使得组件的文档不仅能看,还好用

轻松上手

手动创建第一篇文档

// 创建组件开发的目录
$ mkdir library && cd library
// 安装 dumi
$ npm i dumi
// 创建文档
$ mkdir docs && echo '# Hello dumi!' > docs/index.md
// 预览文档
$ npx dumi dev

谁在使用

反馈与共建

请访问 GitHub 或加入讨论群: