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

Dooringx

Formily

GGEditor

Graphin

issues-helper

LightProxy

pΔ«nyΔ«n

Pro Components

qiankun

react-component

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

About

πŸ“– Documentation Generator of React Component

https://d.umijs.org

License:MIT License


Languages

Language:TypeScript 76.4%Language:Less 12.4%Language:JavaScript 9.1%Language:HTML 1.3%Language:Smarty 0.8%