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)
FAQs
A doc template can assist you to develop libraries & write docs.
The npm package 3d_hall receives a total of 0 weekly downloads. As such, 3d_hall popularity was classified as not popular.
We found that 3d_hall demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.