What is dumi?

dumi is a documentation generator designed specifically for React component libraries. If you're building a collection of reusable React components and need a way to create a polished documentation website, with live examples, usage instructions, and API references, this tool handles that for you so you can focus on writing the code and the docs themselves. The tool works right out of the box, meaning you don't have to spend time wiring together separate pieces for your documentation site. It's built on top of Umi, which is a broader framework for building React applications. One of its standout features is that it extends standard Markdown, the simple text formatting language used for most project documentation, so that you can embed interactive component demos directly within your written docs. You can write a paragraph explaining how a component works, then immediately show a live, working example of that component right on the same page. Teams and individuals building React component libraries are the primary audience. For example, if your team has built a shared set of UI components like buttons, forms, or data tables and you want other developers to understand how to use them, this tool turns your code and Markdown files into a professional documentation site. The README lists several well-known projects that already use it, including ahooks (a popular React hooks library), Pro Components, qiankun, and UmiJS itself, suggesting it's a trusted choice among established React ecosystem projects. The project doesn't go into much detail in the README about specific tradeoffs or architectural decisions, but it does emphasize being "out of the box" ready and extensible. If you want to explore further, the project links to an official site with more examples and a full guide.