dumi

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](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

Discuss group