提交 6c02da04 编写于 作者: D dolymood

docs(quick-start): add vue-cli@3 doc

上级 310c3a23
## Quick start
[Application Guide](https://github.com/cube-ui/cube-application-guide)
- [Application Guide](https://github.com/cube-ui/cube-application-guide)
- Have problems? See [QA](https://github.com/cube-ui/question-answer/issues)
### CLI
#### vue-cli >= 3
If you are using vue-cli@3, you can use [vue-cli-plugin-cube-ui](https://github.com/cube-ui/vue-cli-plugin-cube-ui) plugin. After you inited your project, just run `vue add cube-ui`. About options, see [cube-template WIKI](https://github.com/cube-ui/cube-template/wiki).
Then you can see the <a href="#cube-Usage-anchor" class="anchor">Usage</a> part directly.
#### vue-cli < 3
If you are going to create a new project with cube-ui, use the [cli tools](https://github.com/cube-ui/cube-template) base on [vue-cli](https://github.com/vuejs/vue-cli) to init the config and base code, then you can ignore the <a href="#cube-Install-anchor" class="anchor">Install</a> steps and see the <a href="#cube-Usage-anchor" class="anchor">Usage</a> part directly.
```shell
......@@ -16,7 +26,10 @@ If you are going to use cube-ui in an existing project, see the <a href="#cube-I
### Install
> This section only used in the case of vue-cli < 3
#### NPM
```shell
$ npm install cube-ui --save
```
......
## 快速上手
新手教程项目:[cube-application-guide](https://github.com/cube-ui/cube-application-guide)
- 新手教程项目:[cube-application-guide](https://github.com/cube-ui/cube-application-guide)
- 遇到问题,先移步 [QA](https://github.com/cube-ui/question-answer/issues)
### 脚手架
如果你打算用在一个新项目中使用 cube-ui,可以通过我们提供的一套基于 [vue-cli](https://github.com/vuejs/vue-cli) 实现的[脚手架](https://github.com/cube-ui/cube-template)去初始化 cube-ui 项目的配置和基础代码,这样你就可以忽略<a href="#cube-安装-anchor" class="anchor">安装</a>步骤,直接看<a href="#cube-使用-anchor" class="anchor">使用部分</a>
#### vue-cli >= 3
如果你正在使用新版本的 Vue CLI vue-cli@3,那么推荐你直接使用 [vue-cli-plugin-cube-ui](https://github.com/cube-ui/vue-cli-plugin-cube-ui) 插件。在你初始化完项目后直接执行 `vue add cube-ui` 即可。
在执行的时候,会询问一些配置项,这个和老版本的 [模板](https://github.com/cube-ui/cube-template) 配置是一样的,参见 [cube-template WIKI](https://github.com/cube-ui/cube-template/wiki)
执行完成后,你可以直接进入<a href="#cube-使用-anchor" class="anchor">使用部分</a>
#### vue-cli < 3
如果你打算用在一个新项目中使用 cube-ui,可以通过我们提供的一套基于 [vue-cli](https://github.com/vuejs/vue-cli) 实现的[脚手架模板](https://github.com/cube-ui/cube-template)去初始化 cube-ui 项目的配置和基础代码,这样你就可以忽略<a href="#cube-安装-anchor" class="anchor">安装</a>步骤,直接看<a href="#cube-使用-anchor" class="anchor">使用部分</a>
```shell
$ vue init cube-ui/cube-template projectname
......@@ -16,6 +27,8 @@ $ vue init cube-ui/cube-template projectname
### 安装
> 此安装部分只针对于 vue-cli < 3 的情况
#### NPM
```shell
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册