Uheinanba / 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

A doc tool base on Umi that can help you dev library & write doc.

Features

  • πŸ“¦ Out of the box, focus on development & documentation
  • πŸš€ Base on Umi 3, high-performance & extensible
  • πŸ“‹ Powerful Markdown extensions, support embed demo, external demo & inline demo

Usage & Guide

To check out live examples and docs, visit dumi official site.

Development

$ yarn
$ yarn watch
$ yarn dev

Who is using dumi?


UmiJS

Umi Hooks

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

About

πŸ“– Documentation Generator of React Component

https://d.umijs.org


Languages

Language:TypeScript 70.3%Language:CSS 14.7%Language:JavaScript 11.4%Language:HTML 2.1%Language:Smarty 1.5%