Skip to content
/ dumi-template Public template

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

License

Notifications You must be signed in to change notification settings

umijs/dumi-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

18 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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

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