项目简介
本项目利用dumi框架创建组件库。dumi是基于UmiJS的文档工具,可用于开发组件库并生成对应API文档。通过该项目,能学习到组件库从初始化、组件创建、文档编写,到打包编译、发布与使用的完整流程。
项目的主要特性和功能
- 易于维护和扩展:dumi提供简洁文档编写方式,开发者可像用户一样编写Demo,便于组件库的维护和扩展。
- 强大的依赖管理:借助father - build进行编译,保证依赖管理清晰,减少不必要的错误。
- 统一的API文档:自动生成API文档,方便用户了解和使用组件库。
安装使用步骤
假设已下载本项目的源码文件,可按以下步骤操作:
1. 确保已安装Node.js环境(版本需在10以上)。
2. 进入项目目录,安装依赖:
bash
npm install
3. 启动项目,查看效果:
bash
npm start
访问 http://localhost:8000
查看效果和文档。
4. 若要创建新组件,例如简单的Button组件,可在src
目录下创建对应组件目录,并编写index.ts
和index.less
文件。
5. 为组件编写用例,在组件目录下创建index.md
文件,并导入组件进行展示。
6. 运行查看效果,确保组件和文档正常显示。
7. 打包编译项目:
bash
npm run build
8. 发布组件库到npm。确定组件库名称未被使用,执行npm publish
发布。
9. 在其他项目中使用组件库。通过npm安装,然后在项目中使用相应的组件:
bash
yarn add dumi - oni
```js
import React from 'react';
import { Button } from 'dumi - oni';
export default () => <Button type="secondary">secondary</Button>;
```
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】