dumi

A Umi-based doc tool can assist you to develop libraries & write docs.

Out of the box

Elegant default configrations and convention routing assist developers to get started as simple as possible, that focus all attentions on developing libraries & writting docs

high-performance

Based on powerful Umi, dumi is not only high-performance & extensible, but also could use mostly plugins based on Umi

For developing libraries

Powerful Markdown extensions, that could embed demos or import external demos or even insert custom React components, make docs beautiful & better to use

Getting Started

Create first doc in manual way

// Create dir for libraries
$ mkdir library && cd library
// Install dumi
$ npm i dumi
// Create docs
$ mkdir docs && echo '# Hello dumi!' > docs/index.md
// Preview docs
$ npx dumi dev

Who are using

Feedback

Please visit GitHub or join the discuss group