<p align="center">
  <img width="300px" src="https://user-images.githubusercontent.com/10731096/95823103-9ce15780-0d5f-11eb-8010-1bd1b5910d4f.png">
</p>

<p align="center">
  <a href="https://www.npmjs.org/package/element-plus">
      <img alt="npm (yi-design)" src="https://img.shields.io/npm/v/@yi-design/yi-ui?color=%232589ff&style=flat-square">
  </a>
</p>

<p align="center">YiUi - A Vue.js 3.0 UI library</p>

- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript
## Documentation

您可以在以下内容中找到更多详细信息、API 和其他文档：
<!-- [https://element-plus.org](https://element-plus.org/) -->
<!-- 国内[加速镜像站点](https://element-plus.gitee.io/) -->

## 启动项目

执行

```bash
$ yarn bootstrap
```

安装项目依赖项并执行`lerna bootstrap`初始化项目

## 预览站点

执行

```bash
$ yarn website-dev
```

该项目将提供所有组件的预览以及使用说明

也可以使用此命令启动空白页进行调试

```bash
$ yarn website-dev:play
//source file: ./website/play/index.vue
```

## 创建一个新组件

执行

```bash
$ yarn gen component-name
```

请注意, "component-name"必须是[kebab-case(短横线命名)]，组合单词之间的空格用破折号代替。

## Git 代码提交

执行

```bash
yarn cz
```

举例：

```
[TYPE](SCOPE):DESCRIPTION#[ISSUE]

# feat(button): add type 'button' for form usage #1234
```
