Need help with dumi?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

umijs
1.9K Stars 720 Forks MIT License 1.1K Commits 64 Opened issues

Description

📖 Documentation Generator of React Component

Services available

!
?

Need anything else?

Contributors list

dumi

codecov NPM version GitHub Actions status NPM downloads lerna issues-helper

Intro

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

Features

  • 📦 Out of the box, focus on component development and documentation
  • 📋 Rich Markdown extensions, more than just rendering component demo
  • 🏷 Automatically generate component API based on TypeScript type definition
  • 🎨 Easily customize the theme, and create your own Markdown components
  • 📱 Support mobile component library development, built-in mobile HD rendering solution
  • 📡 One-line command digitizes component assets and connects them with downstream productivity tools

Usage & Guide

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

Development

$ yarn
$ yarn watch
$ yarn dev

Who are using dumi?


ahooks

alitajs

antd-cpi

Formily

GGEditor

Graphin

issues-helper

juejin-cn

LightProxy

Pro Components

qiankun

react-component

react-org-tree

Remax

UmiJS

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.