# dumi

Static site framework for documenting component libraries, with demos rendered next to their source.


Source: https://findsoftware.frbit.cloud/dumi/
Last reviewed: 2026-10-21
Updated: 2026-10-25
Listed since: 2026-10-21

## Record

### Links

- home: https://d.umijs.org
- repository: https://github.com/umijs/dumi
- docs: https://d.umijs.org/guide

### Identity

- status: active
- maintainer: UmiJS Team
- maintainerType: community
- parent: unknown
- firstRelease: 2019
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: javascript
- runtime: node
- runtimeMin: node 20
- basedOn: umi

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: true

### Rendering and deploy

- runsAs: static
- renderingModes: static
- installMethod: npm create

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 2
- latestReleaseDate: 2026-10-19

### Adoption

- githubStargazers: 3795
- packagistDownloads: not applicable
- npmWeeklyDownloads: 12016
- contributors: unknown
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 1864
- dependentPackages: 3841

### Sources

- urls: https://d.umijs.org (read 2026-10-21)
- urls: https://api.github.com/repos/umijs/dumi (read 2026-10-21)
- urls: https://d.umijs.org/guide (read 2026-10-21)
- firstRelease: https://registry.npmjs.org/dumi (read 2026-10-21)
- maintainer: https://github.com/umijs/dumi/blob/master/LICENSE (read 2026-10-21)
- category: https://d.umijs.org/guide (read 2026-10-21)
- language: https://api.github.com/repos/umijs/dumi (read 2026-10-21)
- runtime: https://d.umijs.org/guide/initialize (read 2026-10-21)
- runtimeMin: https://d.umijs.org/guide/initialize (read 2026-10-21)
- installMethod: https://d.umijs.org/guide/initialize (read 2026-10-21)
- renderingModes: https://d.umijs.org/guide (read 2026-10-21)
- runsAs: https://d.umijs.org/guide/faq (read 2026-10-21)
- basedOn: https://d.umijs.org/guide/faq (read 2026-10-21)
- i18n: https://d.umijs.org/guide/i18n (read 2026-10-21)
- license: https://api.github.com/repos/umijs/dumi (read 2026-10-21)
- license: https://d.umijs.org (read 2026-10-21)
- currentMajor: https://registry.npmjs.org/dumi/latest (read 2026-10-21)
- latestReleaseDate: https://api.github.com/repos/umijs/dumi/releases/latest (read 2026-10-21)
- githubStargazers: https://api.github.com/repos/umijs/dumi (read 2026-10-21)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/point/last-week/dumi (read 2026-10-21)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/dumi (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/dumi (read 2026-10-25)

## Notes

dumi is a static site framework for documenting component libraries, built on Umi. A project is created with `npx create-dumi`, and the [initialization guide](https://d.umijs.org/guide/initialize) asks for Node.js 20 or later. The site supports several languages through a `locales` setting in `.dumirc.ts`, as the [i18n guide](https://d.umijs.org/guide/i18n) describes. The FAQ's deployment section builds the site into a `dist` directory and publishes it to GitHub Pages.

The project is maintained by the UmiJS Team and published under the MIT license.

## Worth knowing

The project's own documentation is written in Chinese only, so the [guide](https://d.umijs.org/guide) and the configuration reference are read in Chinese. The README in the repository is in English and links to the Chinese site.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0