What it is

dumi is a static site generator for component library development. It is a JavaScript project in the Umi ecosystem, and its repository is categorized under Content & Publishing / Documentation & Knowledge Base. The project is distributed under the MIT license, and the provided registry data records 3,797 stars, 1,167 forks, 183 open issues, a seven-year repository age, and a last push date of 2026-09-14.

The concrete problem it addresses is documentation for component libraries. Component libraries need a site that explains their purpose and usage, and dumi is described as a docs-generator and static-site-generator for that kind of library-development work. The README points to the official site for online examples and docs, so the primary use case is building documentation sites rather than operating a hosted documentation service.

Key capabilities

• Generates static sites for component library documentation.
• Operates as a docs-generator for library-development projects.
• Fits within the Umi ecosystem, as indicated by the repository topics.
• Provides an official site at https://d.umijs.org for usage, guide, examples, and documentation.
• Offers a README badge for projects that use dumi.
• Is distributed under the MIT license, which supports open-source reuse.

Who uses it and how

• Component library maintainers use dumi to build documentation sites for their packages.
• JavaScript teams working in the Umi ecosystem use it for library-development documentation.
• Users can learn the workflow by reading the official site's online examples and docs.
• Projects can advertise their documentation setup with the README badge supplied in the README.
• Contributors can follow the repository's contributing guide, which the README references as CONTRIBUTING.md.

Getting started

The README identifies dumi as an npm package and directs users to the official site for usage and guide. It does not mention Docker image names, a hosted option, or other deployment methods.

When to use it — and when not to

Choose dumi when a component library needs a static documentation site and the team is comfortable with JavaScript, Umi, and MIT-licensed open-source tooling. Avoid it if a hosted documentation service or explicit deployment guidance is required, because the provided facts only point to the npm package and official site. The 183 open issues and missing contributor count suggest that adopters should review current maintenance status before relying on it.

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