From 6c02da049bbb4e3b9e034db5ce5f62ba075a97cb Mon Sep 17 00:00:00 2001 From: dolymood Date: Mon, 27 Aug 2018 16:56:04 +0800 Subject: [PATCH] docs(quick-start): add vue-cli@3 doc --- document/components/docs/en-US/quick-start.md | 15 ++++++++++++++- document/components/docs/zh-CN/quick-start.md | 17 +++++++++++++++-- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/document/components/docs/en-US/quick-start.md b/document/components/docs/en-US/quick-start.md index 68ba1908..e6e21392 100644 --- a/document/components/docs/en-US/quick-start.md +++ b/document/components/docs/en-US/quick-start.md @@ -1,9 +1,19 @@ ## 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 Usage 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 Install steps and see the Usage part directly. ```shell @@ -16,7 +26,10 @@ If you are going to use cube-ui in an existing project, see the 安装步骤,直接看使用部分。 +#### 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)。 + +执行完成后,你可以直接进入使用部分。 + +#### vue-cli < 3 + +如果你打算用在一个新项目中使用 cube-ui,可以通过我们提供的一套基于 [vue-cli](https://github.com/vuejs/vue-cli) 实现的[脚手架模板](https://github.com/cube-ui/cube-template)去初始化 cube-ui 项目的配置和基础代码,这样你就可以忽略安装步骤,直接看使用部分。 ```shell $ vue init cube-ui/cube-template projectname @@ -16,6 +27,8 @@ $ vue init cube-ui/cube-template projectname ### 安装 +> 此安装部分只针对于 vue-cli < 3 的情况 + #### NPM ```shell -- GitLab