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
โ โโโ Test 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 usagedumi, 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 | Usefather |
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)
ๅฏๅจ
yarn
yarn bootstrap
yarn start
ๆๅ ๆๆกฃ
yarn docs:build
ๆๅ ็ปไปถ
yarn build