# dumi

> 📖 Documentation Generator of React Component

Latest version **2.4.50** (published 2026-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install dumi
pnpm add dumi
yarn add dumi
bun add dumi
```

Provides the command `dumi`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.4.50 |
| Published | 2026-09-14 |
| First published | 2019-12-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 68 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 3797 |
| Maintainers | peachscript, yifankakaxi, zoomdong07 |
| Keywords | generator, umi, webpack, react, static site generator, jamstack, markdown, components, documentation, utoopack |

## Links

- npm: https://www.npmjs.com/package/dumi
- Repository: https://github.com/umijs/dumi
- Homepage: https://d.umijs.org
- Issues: https://github.com/umijs/dumi/issues
- npm.io page: https://npm.io/package/dumi

## Dependencies (68)

- [umi](https://npm.io/package/umi.md) ^4.7.4
- [url](https://npm.io/package/url.md) ^0.11.1
- [heti](https://npm.io/package/heti.md) ^0.9.4
- [sass](https://npm.io/package/sass.md) ^1.64.1
- [vfile](https://npm.io/package/vfile.md) ^5.3.7
- [comlink](https://npm.io/package/comlink.md) ^4.4.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [prismjs](https://npm.io/package/prismjs.md) ^1.29.0
- [rc-tabs](https://npm.io/package/rc-tabs.md) ^12.10.0
- [rc-tree](https://npm.io/package/rc-tree.md) ^5.7.9
- [rc-util](https://npm.io/package/rc-util.md) ^5.38.0
- [sitemap](https://npm.io/package/sitemap.md) ^7.1.1
- [sucrase](https://npm.io/package/sucrase.md) ^3.34.0
- [unified](https://npm.io/package/unified.md) ^10.1.2
- [@swc/core](https://npm.io/package/@swc/core.md) 1.9.2
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.3.1
- [nprogress](https://npm.io/package/nprogress.md) ^0.2.0
- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0
- [rc-motion](https://npm.io/package/rc-motion.md) ^2.7.3
- [classnames](https://npm.io/package/classnames.md) 2.3.2
- [raw-loader](https://npm.io/package/raw-loader.md) ^4.0.2
- [rc-tooltip](https://npm.io/package/rc-tooltip.md) ^6.1.3
- [react-intl](https://npm.io/package/react-intl.md) ^7.0.0
- [remark-gfm](https://npm.io/package/remark-gfm.md) ^3.0.1
- [@types/hast](https://npm.io/package/@types/hast.md) ^2.3.5
- [@umijs/core](https://npm.io/package/@umijs/core.md) ^4.7.4
- [html2sketch](https://npm.io/package/html2sketch.md) ^1.0.2
- [@types/mdast](https://npm.io/package/@types/mdast.md) ^3.0.12
- [@umijs/utils](https://npm.io/package/@umijs/utils.md) ^4.7.4
- [html-to-text](https://npm.io/package/html-to-text.md) ^9.0.5
- [prism-themes](https://npm.io/package/prism-themes.md) ^1.9.0
- [remark-parse](https://npm.io/package/remark-parse.md) ^10.0.2
- [dumi-afx-deps](https://npm.io/package/dumi-afx-deps.md) ^1.0.0-alpha.19
- [hast-util-raw](https://npm.io/package/hast-util-raw.md) ^8.0.0
- [remark-rehype](https://npm.io/package/remark-rehype.md) ^10.1.0
- [github-slugger](https://npm.io/package/github-slugger.md) ^1.5.0
- [@stackblitz/sdk](https://npm.io/package/@stackblitz/sdk.md) ^1.9.0
- [hosted-git-info](https://npm.io/package/hosted-git-info.md) ^6.1.1
- [lodash.throttle](https://npm.io/package/lodash.throttle.md) ^4.1.1
- [@makotot/ghostui](https://npm.io/package/@makotot/ghostui.md) ^2.0.0
- [enhanced-resolve](https://npm.io/package/enhanced-resolve.md) ^5.15.0
- [rehype-stringify](https://npm.io/package/rehype-stringify.md) ^9.0.3
- [remark-directive](https://npm.io/package/remark-directive.md) ^2.0.1
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^4.1.2
- [v8-compile-cache](https://npm.io/package/v8-compile-cache.md) 2.3.0
- [copy-to-clipboard](https://npm.io/package/copy-to-clipboard.md) ^3.3.3
- [dumi-assets-types](https://npm.io/package/dumi-assets-types.md) 2.4.14
- [estree-util-to-js](https://npm.io/package/estree-util-to-js.md) ^1.2.0
- [estree-util-visit](https://npm.io/package/estree-util-visit.md) ^1.2.1
- [file-system-cache](https://npm.io/package/file-system-cache.md) 2.4.4
- [animated-scroll-to](https://npm.io/package/animated-scroll-to.md) ^2.3.0
- [remark-frontmatter](https://npm.io/package/remark-frontmatter.md) ^4.0.1
- [hast-util-to-estree](https://npm.io/package/hast-util-to-estree.md) ^2.3.3
- [hast-util-to-string](https://npm.io/package/hast-util-to-string.md) ^2.0.0
- [@umijs/bundler-utils](https://npm.io/package/@umijs/bundler-utils.md) ^4.7.4
- [hast-util-is-element](https://npm.io/package/hast-util-is-element.md) ^2.1.3
- [mdast-util-to-string](https://npm.io/package/mdast-util-to-string.md) ^3.2.0
- [prism-react-renderer](https://npm.io/package/prism-react-renderer.md) ^1.3.5
- [react-error-boundary](https://npm.io/package/react-error-boundary.md) ^4.0.10
- [@ant-design/icons-svg](https://npm.io/package/@ant-design/icons-svg.md) ^4.4.2
- [react-loading-skeleton](https://npm.io/package/react-loading-skeleton.md) ^3.1.1
- [rehype-remove-comments](https://npm.io/package/rehype-remove-comments.md) ^5.0.0
- [react-copy-to-clipboard](https://npm.io/package/react-copy-to-clipboard.md) ^5.1.0
- [codesandbox-import-utils](https://npm.io/package/codesandbox-import-utils.md) ^2.2.3
- [react-simple-code-editor](https://npm.io/package/react-simple-code-editor.md) ^0.13.1
- [rehype-autolink-headings](https://npm.io/package/rehype-autolink-headings.md) ^6.1.1
- [unist-util-visit-parents](https://npm.io/package/unist-util-visit-parents.md) ^5.1.3
- [mdast-util-find-and-replace](https://npm.io/package/mdast-util-find-and-replace.md) ^2.2.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.4.50 (latest) — 2026-09-14
- 2.4.49-alpha.2 (next) — 2026-08-11
- 2.4.19-beta.0 (beta) — 2025-02-17
- 2.4.16-canary.20241212.1 (canary) — 2024-12-12
- 2.2.15-alpha.0 (test) — 2023-11-28
- 1.1.54 (latest-1) — 2023-10-07
- 1.1.52 (pre) — 2023-08-03
- 2.2.0-alpha.2 (alpha) — 2023-05-06
- 2.4.49 — 2026-08-12
- 2.4.49-alpha.1 — 2026-08-10
- 2.4.49-alpha.0 — 2026-08-09
- 2.4.48 — 2026-07-24
- 2.4.48-alpha.0 — 2026-07-20
- 2.4.47 — 2026-07-17
- 2.4.46 — 2026-07-16
- … 389 more at https://npm.io/package/dumi/versions

## README

# dumi

[![NPM version](https://img.shields.io/npm/v/dumi)](https://npmjs.org/package/dumi) [![NPM downloads](https://img.shields.io/npm/dm/dumi)](https://npmjs.org/package/dumi) [![GitHub CI](https://github.com/umijs/dumi/workflows/CI/badge.svg)](https://github.com/umijs/dumi)

<img src="https://gw.alipayobjects.com/zos/bmw-prod/d3e3eb39-1cd7-4aa5-827c-877deced6b7e/lalxt4g3_w256_h256.png" width="120">

dumi is a static site generator for component library development.

## Usage & Guide

To view more online examples and docs, please visit [dumi official site](https://d.umijs.org).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

<a href="https://openomy.app/github/umijs/dumi" target="_blank" style="display: block; width: 100%;" align="center">
  <img src="https://www.openomy.app/svg?repo=umijs/dumi&chart=bubble&latestMonth=3" target="_blank" alt="Contribution Leaderboard" style="display: block; width: 100%;" />
</a>

## Badge

Using dumi? Add a README badge to show it off: [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

```
[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)
```

## LICENSE

MIT

---
_Source: https://npm.io/package/dumi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
