# dumi

**Repository Path**: git.fccfc.com/dumi

## Basic Information

- **Project Name**: dumi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-19
- **Last Updated**: 2022-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dumi

[![codecov](https://codecov.io/gh/umijs/dumi/branch/master/graph/badge.svg)](https://codecov.io/gh/umijs/dumi) [![NPM version](https://img.shields.io/npm/v/dumi.svg?style=flat)](https://npmjs.org/package/dumi) [![GitHub Actions status](https://github.com/umijs/dumi/workflows/Node%20CI/badge.svg)](https://github.com/umijs/dumi) [![NPM downloads](https://img.shields.io/npm/dm/dumi.svg?style=flat)](https://npmjs.org/package/dumi) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![issues-helper](https://img.shields.io/badge/using-issues--helper-orange)](https://github.com/actions-cool/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](https://d.umijs.org).

## Development

```bash
$ yarn
$ yarn watch
$ yarn dev
```

## Who are using dumi?

<table>

  <tr>
    <td width="160" align="center">
      <a target="_blank" href="https://ahooks.js.org/">
        <img src="https://ahooks.js.org/logo.svg" />
        <br />
        <strong>ahooks</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://alitajs.com/">
        <img src="https://user-images.githubusercontent.com/11746742/104428726-c2c90300-55bf-11eb-9b84-d52a86050b9a.png" width="42" />
        <br />
        <strong>alitajs</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://boyuai.github.io/antd-country-phone-input/">
        <img src="https://staticcdn.boyuai.com/user-assets/6074/vF5on4266Geu54q8dM7mEU/Lark20200122-235918.svg" width="42" />
        <br />
        <strong>antd-cpi</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://github.com/H5-Dooring/dooringx">
        <img src="https://img-blog.csdnimg.cn/img_convert/520863a38a93d960862f92c805bc97cc.png" />
        <br />
        <strong>Dooringx</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://v2.formilyjs.org/">
        <img src="https://img.alicdn.com/imgextra/i2/O1CN01Kq3OHU1fph6LGqjIz_!!6000000004056-55-tps-1141-150.svg" />
        <br />
        <strong>Formily</strong>
      </a>
    </td>
  </tr>
  <tr>
    <td width="160" align="center">
      <a target="_blank" href="https://ggeditor.com">
        <img src="https://img.alicdn.com/tfs/TB1FFA1CFP7gK0jSZFjXXc5aXXa-214-200.png" width="42" />
        <br />
        <strong>GGEditor</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://graphin.antv.vision/">
        <img src="https://gw.alipayobjects.com/zos/antfincdn/0b4HzOcEJY/Graphin.svg" width="42" />
        <br />
        <strong>Graphin</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://actions-cool.github.io/issues-helper/">
        <img src="https://avatars1.githubusercontent.com/u/73879334?s=200&v=4" width="42" />
        <br />
        <strong>issues-helper</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://lightproxy.org">
        <img src="https://user-images.githubusercontent.com/5436704/81533849-83e00f00-9399-11ea-943d-ac5fd4653906.png" width="42" />
        <br />
        <strong>LightProxy</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://pinyin.js.org/">
        <img src="https://gw.alipayobjects.com/mdn/rms_f6322a/afts/img/A*bGz9QbNudekAAAAAAAAAAAAAARQnAQ" width="42" />
        <br />
        <strong>pīnyīn</strong>
      </a>
    </td>
  </tr>
  <tr>
    <td width="160" align="center">
      <a target="_blank" href="https://procomponents.ant.design/">
        <img src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" width="42" />
        <br />
        <strong>Pro Components</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://qiankun.umijs.org/">
        <img src="https://gw.alipayobjects.com/zos/bmw-prod/8a74c1d3-16f3-4719-be63-15e467a68a24/km0cv8vn_w500_h500.png" width="42" />
        <br />
        <strong>qiankun</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://github.com/react-component">
        <img src="https://avatars3.githubusercontent.com/u/9441414?s=200&v=4" width="42" />
        <br />
        <strong>react-component</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://remaxjs.org">
        <img src="https://gw.alipayobjects.com/mdn/rms_b5fcc5/afts/img/A*1NHAQYduQiQAAAAAAAAAAABkARQnAQ" width="42" />
        <br />
        <strong>Remax</strong>
      </a>
    </td>
    <td width="160" align="center">
      <a target="_blank" href="https://umijs.org">
        <img src="https://gw.alipayobjects.com/zos/bmw-prod/598d14af-4f1c-497d-b579-5ac42cd4dd1f/k7bjua9c_w132_h130.png" width="42" />
        <br />
        <strong>UmiJS</strong>
      </a>
    </td>
  </tr>
</table>

### README Badge

Using dumi ? Add a README badge to show it off: [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

```
[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)
```

## Discuss group

<div>
  <img data-type="dingtalk" src="https://gw.alipayobjects.com/zos/bmw-prod/ce3439e7-3bf9-4031-b823-6473439ec9e6/kxkiis4c_w1004_h1346.jpeg" width="300" />
  <img data-type="wechat" src="https://gw.alipayobjects.com/zos/bmw-prod/c18bc2a5-719a-48ca-b225-c79ef88bfb43/k7m10ymd_w1004_h1346.jpeg" width="300" />
</div>