@youzouzou2021/test2

๐ŸŒŸ A doc template(with lerna) can assist you to develop libraries & write docs.

Showing:

Popularity

Downloads/wk

23

GitHub Stars

8

Maintenance

Last Commit

4mos ago

Contributors

2

Package

Dependencies

0

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

๐ŸŒŸ 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

NameDescriptionRemarks
npm run startProject beginingDocument usage dumi, component development and documentation development together
npm run testComponent test-
npm run test:coverageCode coverage review-
npm run prettierCode prettier-
npm run buildComponent packagingUse father
npm run releaseComponent package release-
npm run docs:buildDocument packaging-
npm run docs:deployDocument releaseThe default is to use GitHub Pages
npm run deployDocument package release-

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100