zpd106 / dumi

πŸ“– Documentation Generator of React Component

Home Page:https://d.umijs.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

dumi

codecov NPM version CircleCI GitHub Actions status NPM downloads lerna

Intro

An 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 Layout

Pro Table

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

https://d.umijs.org


Languages

Language:TypeScript 70.7%Language:Less 14.5%Language:JavaScript 11.3%Language:HTML 2.1%Language:Smarty 1.4%