Generator Dumi 专为组件库打造的静态文档站生成器

一、项目介绍

维护开源组件库，最缺的是“配套文档站”：你写了很多组件，却要另搭一套站点来演示与说明，成本高、还容易和代码脱节。你想写 Markdown 就出文档，却被站点工程缠住。
dumi 是 umi 生态里专为组件库设计的静态文档站生成器：用 Markdown 写文档、内嵌组件实时预览，约定式路由，构建出静态站轻松部署，让组件库与文档同步生长。

二、项目基本信息

三、核心优势

• 为组件库而生，Markdown 即文档
• 代码实时预览，文档与演示一体
• 约定式路由，少配置
• 与 umi / React 生态天然契合
• 构建为静态站，部署无忧

四、适用场景

适合维护开源组件库、需要自动生成可演示文档站的前端开发者。

五、安装教程

当前最新版本 v2.4.53。按下方命令安装（如遇网络问题可切换镜像源或代理）：

# 在组件库项目中初始化 dumi 文档
npm init dumi
# 或已有项目追加
npm install dumi -D

常见报错：依赖缺失时先升级运行环境（Node、Python、Go、JDK 等）到项目要求版本；网络超时多为镜像或代理问题，可重试或换源。权限类报错请确认已登录对应平台账号。

六、使用示例

下面是一段可直接参考的真实示例：

npm run dev      # 本地启动文档站点（默认 8000）
npm run build    # 构建静态文档站
npm run preview  # 预览构建结果

七、常见问题

问：只用于 React 吗？答：dumi 主要为 React 组件库设计。问：文档站能部署哪？答：构建为静态文件，任意静态托管均可。

八、总结

Dumi 用一个清晰的设计，把把文档与站点生成自动化这件反复劳动变成了可复用、可维护的能力。它不追求大而全，而是把核心痛点解决得足够扎实——这正是日常开发与团队落地时最需要的那种工具。如果你也在被同类问题困扰，不妨按上面的安装与使用步骤试一试，把它接进自己的工作流。