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:
[](https://github.com/umijs/dumi)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent