đ A doc template can assist you to develop libraries & write docs.
A doc template can assist you to develop libraries & write docs.
English | įŽäŊä¸æ
https://umijs.github.io/dumi-template/
âââ 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.
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 | - |
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)