Frans 7 years ago
parent
commit
5aba9cb12f
4 changed files with 50 additions and 11 deletions
  1. 48 4
      docs/start.md
  2. 1 1
      package.json
  3. 1 1
      sites/doc/asset/css/style-blue.scss
  4. 0 5
      src/nutui.js

+ 48 - 4
docs/start.md

@@ -1,11 +1,12 @@
 # 快速上手
 # 快速上手
 
 
 ## 推荐工程
 ## 推荐工程
+
 我们提供一个命令行工具 [Gaea-cli](https://www.npmjs.com/package/gaea-cli) ,可用来快速生成一个已经内置了本组件库的基于 Webpack 的 Vue 项目工程。基于这个工程开发项目,可省去大量配置和调试环境的时间,也可略过下面组件库安装使用部分内容直接进入开发阶段。
 我们提供一个命令行工具 [Gaea-cli](https://www.npmjs.com/package/gaea-cli) ,可用来快速生成一个已经内置了本组件库的基于 Webpack 的 Vue 项目工程。基于这个工程开发项目,可省去大量配置和调试环境的时间,也可略过下面组件库安装使用部分内容直接进入开发阶段。
 
 
 ## 安装
 ## 安装
 
 
-推荐使用 NPM 或 YARN 安装
+* 推荐使用 NPM 或 YARN 安装(推荐)
 
 
 #### NPM
 #### NPM
 ```bash
 ```bash
@@ -20,11 +21,11 @@ yarn add @nutui/nutui
 
 
 > 默认安装最新版,如需使用 1.x 版本,请指定版本号,如:  `npm i @nutui/nutui@1.3.2 -S`
 > 默认安装最新版,如需使用 1.x 版本,请指定版本号,如:  `npm i @nutui/nutui@1.3.2 -S`
 
 
-#### 页面引入
+* 页面直接引用
 
 
-在页面中使用 script 和 link 标签直接引入文件,并使用全局变量 nutui。我们在 npm 发布包内的 dist 目录下提供了 **nutui.js** **nutui.css** 以及 **nutui.min.js** **nutui.min.css**。
+在页面中使用 script 和 link 标签直接引入文件,**NutUI** 将会自动注册。我们在 npm 发布包内的 dist 目录下提供了 **nutui.js** **nutui.css** 以及 **nutui.min.js** **nutui.min.css**。
 
 
-当然你也可以通过CDN的方式引入。
+当然你也可以通过 CDN 的方式引入, 可以在 **jsdelivr** 和 **unpkg** 等公共 CDN 上获取到 NutUI。我们推荐链接到一个你可以手动更新的指定版本号
 
 
 ```html
 ```html
 <!-- 引入样式 -->
 <!-- 引入样式 -->
@@ -35,8 +36,51 @@ yarn add @nutui/nutui
 <script src="https://cdn.jsdelivr.net/npm/@nutui/nutui@latest/dist/nutui.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/@nutui/nutui@latest/dist/nutui.min.js"></script>
 ```
 ```
 
 
+CDN 引入示例
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <!-- 引入样式 -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@nutui/nutui@latest/dist/nutui.min.css">
+</head>
+<body>
+    <div id="app">
+        <nut-button @click="showDialog">
+            Button
+        </nut-button>
+    </div>
+
+    <!-- 引入Vue -->
+    <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
+    <!-- 引入NutUI组件库 -->
+    <script src="https://cdn.jsdelivr.net/npm/@nutui/nutui@latest/dist/nutui.min.js"></script>
+    <script>
+        new Vue({
+            el: '#app',
+            methods: {
+                showDialog() {
+                    this.$dialog({
+                        title: "确定删除此订单?",
+                        content: "删除后将从你的记录里消失,无法找回"
+                    });
+                }
+            }
+        });
+    </script>
+</body>
+</html>
+```
+
 > 在页面中直接引入,将无法使用 **主题换肤** 等功能。我们推荐使用 *NPM* 或 *YARN* 方式安装,不推荐在页面中直接引入的用法
 > 在页面中直接引入,将无法使用 **主题换肤** 等功能。我们推荐使用 *NPM* 或 *YARN* 方式安装,不推荐在页面中直接引入的用法
 
 
+* 通过 **Vue-cli** 图形化界面安装
+
+如果你的项目是使用 [Vue-cli](https://cli.vuejs.org/zh/) 脚手架搭建,那么你还可以通过 **Vue-cli** 提供的图形化界面安装 **NutUI** :在图形化界面的 **依赖** 界面,点击右上角 **安装依赖** 按钮,搜索 **@nutui/nutui** 安装即可。
+
 ## 加载示例
 ## 加载示例
 
 
 ```javascript
 ```javascript

+ 1 - 1
package.json

@@ -24,7 +24,7 @@
     "build": "npm run build:prod && npm run build:prodmin && npm run build:disp",
     "build": "npm run build:prod && npm run build:prodmin && npm run build:disp",
     "eslint": "eslint src/packages/**/*.{js,vue}",
     "eslint": "eslint src/packages/**/*.{js,vue}",
     "add": "node scripts/createCptTpl.js",
     "add": "node scripts/createCptTpl.js",
-    "test": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text  mocha-webpack --webpack-config build/webpack.test.conf.js --require test/setup.js src/packages/picker/__test__/**.spec.js",
+    "test": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text  mocha-webpack --webpack-config build/webpack.test.conf.js --require test/setup.js src/packages/*/__test__/**.spec.js",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
     "test:watch": "npm run test --watch"
     "test:watch": "npm run test --watch"
   },
   },

+ 1 - 1
sites/doc/asset/css/style-blue.scss

@@ -70,7 +70,7 @@
     }
     }
     ul {
     ul {
         border-radius: 3px;
         border-radius: 3px;
-        padding: 5px 20px;
+        padding: 5px 20px 5px 0;
         list-style: none;
         list-style: none;
         p {
         p {
             margin: 0;
             margin: 0;

+ 0 - 5
src/nutui.js

@@ -64,11 +64,6 @@ if (typeof window !== 'undefined' && window.Vue) {
     install(window.Vue);
     install(window.Vue);
 }
 }
 
 
-// const API = Object.assign({
-//     version: version,
-//     install
-// }, components, filters, directives, methods);
-
 const API = {
 const API = {
     version,
     version,
     locale,
     locale,