Skip to content
forked from umijs/dumi

๐Ÿ“– Documentation Generator of React Component

Notifications You must be signed in to change notification settings

AlbertXiaoPeng/dumi

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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

About

๐Ÿ“– Documentation Generator of React Component

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 75.8%
  • Less 12.8%
  • JavaScript 8.9%
  • HTML 1.4%
  • Smarty 1.1%