Coder Social home page Coder Social logo

zzsimon / dumi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from umijs/dumi

0.0 0.0 0.0 2.2 MB

๐Ÿ“– Documentation Generator of React Component

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

License: MIT License

JavaScript 9.02% TypeScript 76.59% HTML 1.32% Smarty 0.78% Less 12.29%

dumi's Introduction

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

XRender

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

dumi's People

Contributors

peachscript avatar xrkffgg avatar xiaohuoni avatar ycjcl868 avatar mortalyoung avatar chenshuai2144 avatar lbwa avatar ttys026 avatar afc163 avatar ltaoo avatar deturium avatar helsonxiao avatar ppbl avatar cnyballk avatar saber2pr avatar shaodahong avatar binyellow avatar yue-plus avatar onlyling avatar kagawagao avatar 3lang3 avatar mxszs avatar headwindz avatar xialeistudio avatar kenve avatar xz8la8 avatar jljsj33 avatar heyimaster avatar dunqing avatar huanz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.