@aboll/mform 中文文档教程

Question

Dumi Template

A doc template can assist you to develop libraries & write docs.

English | 简体中文

How to use?

✨ Online preview

https://umijs.github.io/dumi-template/

Catalog Introduction

├── docs                   Component documentation
│   ├── index.md           Home page
│   └── **.**              Site Directory Document
├── src                    Component home directory
│   ├── index.ts           Component registration
│   └── Foo                Component development
├── .eslintrc.js           eslint config
├── .fatherrc.ts           father config
├── .umirc.ts              dumi config
└── tsconfig.json          typescript config

The rest of the documents can be consulted by yourself.

Command introduction

Name	Description	Remarks
npm run start	Project begining	Document usage dumi, component development and documentation development together
npm run test	Component test	-
npm run test:coverage	Code coverage review	-
npm run prettier	Code prettier	-
npm run build	Component packaging	Use father
npm run release	Component package release	-
npm run docs:build	Document packaging	-
npm run docs:deploy	Document release	The default is to use GitHub Pages
npm run deploy	Document package release	-

Who are using dumi?

ahooks	alitajs	GGEditor	issues-helper	juejin-im
LightProxy	Pro Components	react-component	Remax	UmiJS

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)

Discuss group