Skip to content

Files

Latest commit

 

History

History
157 lines (139 loc) · 5.55 KB

README.zh-CN.md

File metadata and controls

157 lines (139 loc) · 5.55 KB

🌟 Dumi Template

基于 Umi、为组件开发场景而生的文档模板

English | 简体中文

🚀 如何使用?

✨ 在线预览

https://umijs.github.io/dumi-template/

📒 目录介绍

├── docs                   文档存放路径
│   ├── index.md           首页展示
│   └── **.**              网站目录文档
├── src                    组件主目录
│   ├── index.ts           组件注册
│   └── Foo                组件开发
├── .eslintrc.js           eslint 配置
├── .fatherrc.ts           father 配置
├── .umirc.ts              dumi 配置
└── tsconfig.json          typescript 配置

其余文件可自行查阅了解。

🤖 命令介绍

名称 描述 备注
npm run start 项目启动 使用 dumi,组件开发和文档开发在一起
npm run test 组件测试 -
npm run test:coverage 代码覆盖率查看 -
npm run prettier 代码美化 -
npm run build 组件打包 使用 father 工具
npm run release 组件打包发布 -
npm run docs:build 文档打包 -
npm run docs:deploy 文档发布 这里默认是使用了 GitHub Pages
npm run deploy 文档打包发布 -

💖 谁在使用?


UmiJS

ahooks

Pro Components

react-component

GGEditor

Remax

LightProxy

juejin-im

README 徽章

快来领取徽章展示吧:dumi

[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

交流群