/dumi

📖 Documentation Generator of React Component

Primary LanguageTypeScript

dumi

codecov NPM version CircleCI GitHub Actions status NPM downloads lerna

Intro

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

Features

  • 📦 Out of the box, focus on development & documentation
  • 🚀 Based on Umi 3, high-performance & extensible
  • 📋 Powerful Markdown extensions, support to embed demo or import external demo & inline demo

Usage & Guide

To view more online examples and docs, please visit dumi official site.

Development

$ yarn
$ yarn watch
$ yarn dev

Who are using dumi?


UmiJS

ahooks

Pro Components

react-component

GGEditor

Remax

LightProxy

juejin-im

README Badge

Using dumi ? Add a README badge to show it off: dumi

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

Discuss group