修改：文档的发布方式

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+#### Check List
+- [ ] Every Commit message is meaningful
+- [ ] Synchronized with the main branch
+- [ ] CI passed
+
+#### What changed
+-
+
+#### Breaking Change
+- [ ] Yes
+- [ ] No

.gitignore

@@ -3,3 +3,5 @@ dist
 npm-debug.log
 yarn-error.log
 lib
+docs/index.min.js
+docs/style.min.css

build/rollup.config.js

@@ -1,14 +1,15 @@
-var rollup = require('rollup')
-var vue = require('rollup-plugin-vue')
-var resolve = require('rollup-plugin-node-resolve')
-var babel = require('rollup-plugin-babel')
-var eslint = require('rollup-plugin-eslint')
-var componentInfo = require('../src/component-list')
-var uglify = require('rollup-plugin-uglify')
-var autoprefixer = require('autoprefixer')
-var cssnano = require('cssnano')
-var pkg = []
-var pkgTypeList = [
+const rollup = require('rollup')
+const vue = require('rollup-plugin-vue')
+const resolve = require('rollup-plugin-node-resolve')
+const babel = require('rollup-plugin-babel')
+const eslint = require('rollup-plugin-eslint')
+const componentInfo = require('../src/component-list')
+const uglify = require('rollup-plugin-uglify')
+const autoprefixer = require('autoprefixer')
+const cssnano = require('cssnano')
+
+let pkg = []
+const pkgTypeList = [
   { type: 'cjs', min: false, suffix: '.common.js' },
   { type: 'cjs', min: true, suffix: '.common.min.js' },
   { type: 'umd', min: false, suffix: '.js' },
@@ -17,13 +18,14 @@ var pkgTypeList = [
 
 pkgTypeList.forEach(({ type, min, suffix }) => {
   Object.keys(componentInfo).forEach(name => {
+    const { src, dist } = componentInfo[name]
     pkg.push({
       min,
       type,
       suffix,
       globalName: name,
-      src: componentInfo[name].src,
-      dist: componentInfo[name].dist
+      src,
+      dist
     })
   })
 })
@@ -46,7 +48,8 @@ function rollupFn (item) {
   const vueSettings = item.min
     ? { css: 'lib/style.min.css', postcss: [autoprefixer, cssnano] }
     : { css: 'lib/style.css', postcss: [autoprefixer] }
-  var plugins = [
+
+  const plugins = [
     eslint({
       throwError: true,
       exclude: 'node_modules/**'
@@ -61,12 +64,14 @@ function rollupFn (item) {
     })
   ]
   if (item.min) plugins.push(uglify())
+
   rollup.rollup({
     entry: item.src,
     external: id => /^echarts/.test(id),
     plugins
   }).then(function (bundle) {
-    var dest = item.dist + item.suffix
+    const dest = item.dist + item.suffix
+
     bundle.write({
       format: item.type,
       moduleName: item.globalName,

build/webpack.config.js

@@ -1,8 +1,8 @@
-var path = require('path')
-var webpack = require('webpack')
-var CopyWebpackPlugin = require('copy-webpack-plugin')
-var HtmlWebpackPlugin = require('html-webpack-plugin')
-var opn = require('opn')
+const path = require('path')
+const webpack = require('webpack')
+const CopyWebpackPlugin = require('copy-webpack-plugin')
+const HtmlWebpackPlugin = require('html-webpack-plugin')
+const opn = require('opn')
 
 opn('http://localhost:8099')
 function resolve (dir) {

docs/index.html

@@ -27,8 +27,9 @@
     window.$docsify = {
       name: 'v-charts',
       repo: 'https://github.com/elemefe/v-charts',
-      loadSidebar: true,
-      ga: 'UA-104697795-1'
+      loadSidebar: 'sidebar.md',
+      ga: 'UA-104697795-1',
+      homepage: 'install.md'
     }
   </script>
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

docs/map.md

@@ -155,4 +155,4 @@
 | label | 文本标签 | Boolean, Object | 默认为`true`, 内容参考[文档](http://echarts.baidu.com/option.html#series-map.label) |
 | itemStyle | 地图区域的多边形 图形样式 | Boolean, Object | 默认为true, 内容参考[文档](http://echarts.baidu.com/option.html#series-map.itemStyle) |
 
-> 备注1. 属性中的 position 默认为'china',可设置的类型有'china'、'china-cities'、'china-contour'、'world'、'province/beijing'、'province/shanghai'等，省份的position如例子中所示需要在前面加'province/'
+> 备注: 属性中的 position 默认为'china',可设置的类型有'china'、'china-cities'、'china-contour'、'world'、'province/beijing'、'province/shanghai'等，省份的position如例子中所示需要在前面加'province/'

package.json

@@ -7,7 +7,9 @@
     "dev": "webpack-dev-server --config ./build/webpack.config.js",
     "build": "rm -f -r lib && node build/rollup.config.js && cp -f lib/index.min.js lib/style.min.css docs/",
     "prepublish": "npm run build",
-    "test": "karma start ./test/karma.conf.js"
+    "test": "karma start ./test/karma.conf.js",
+    "docs": "docsify serve docs",
+    "deploy": "gh-pages -d docs"
   },
   "repository": {
     "type": "git",
@@ -39,6 +41,7 @@
     "copy-webpack-plugin": "4.0.1",
     "css-loader": "0.27.3",
     "cssnano": "^3.10.0",
+    "docsify": "^4.3.8",
     "eslint": "3.17.1",
     "eslint-config-standard": "7.0.1",
     "eslint-friendly-formatter": "2.0.7",
@@ -48,6 +51,7 @@
     "eslint-plugin-standard": "2.1.1",
     "extract-text-webpack-plugin": "2.1.0",
     "file-loader": "0.11.1",
+    "gh-pages": "^1.0.0",
     "html-webpack-plugin": "2.30.1",
     "jasmine-core": "2.6.2",
     "karma": "1.7.0",

yarn.lock

@@ -213,6 +213,12 @@ async-foreach@^0.1.3:
   version "0.1.3"
   resolved "https://registry.yarnpkg.com/async-foreach/-/async-foreach-0.1.3.tgz#36121f845c0578172de419a97dbeb1d16ec34542"
 
+async@2.1.4:
+  version "2.1.4"
+  resolved "https://registry.yarnpkg.com/async/-/async-2.1.4.tgz#2d2160c7788032e4dd6cbe2502f1f9a2c8f6cde4"
+  dependencies:
+    lodash "^4.14.0"
+
 async@^1.5.2:
   version "1.5.2"
   resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
@@ -911,6 +917,10 @@ base64id@1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/base64id/-/base64id-1.0.0.tgz#47688cb99bb6804f0e06d3e763b1c32e57d8e6b6"
 
+base64url@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/base64url/-/base64url-2.0.0.tgz#eac16e03ea1438eff9423d69baa36262ed1f70bb"
+
 batch@0.6.1:
   version "0.6.1"
   resolved "https://registry.yarnpkg.com/batch/-/batch-0.6.1.tgz#dc34314f4e679318093fc760272525f94bf25c16"
@@ -1380,6 +1390,12 @@ commander@2.8.x:
   dependencies:
     graceful-readlink ">= 1.0.0"
 
+commander@2.9.0:
+  version "2.9.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.9.0.tgz#9c99094176e12240cb22d6c5146098400fe0f7d4"
+  dependencies:
+    graceful-readlink ">= 1.0.0"
+
 commondir@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b"
@@ -1838,6 +1854,16 @@ diffie-hellman@^5.0.0:
     miller-rabin "^4.0.0"
     randombytes "^2.0.0"
 
+docsify@^4.3.8:
+  version "4.3.8"
+  resolved "https://registry.yarnpkg.com/docsify/-/docsify-4.3.8.tgz#d75b9ff527fb9e8b16727c34b3653913567b2b15"
+  dependencies:
+    marked "^0.3.6"
+    prismjs "^1.6.0"
+    tinydate "^1.0.0"
+    tweezer.js "^1.4.0"
+    zoom-image "^0.1.4"
+
 doctrine@^1.2.2:
   version "1.5.0"
   resolved "https://registry.yarnpkg.com/doctrine/-/doctrine-1.5.0.tgz#379dce730f6166f76cefa4e6707a159b02c5a6fa"
@@ -2526,6 +2552,14 @@ fs-extra@^0.26.4:
     path-is-absolute "^1.0.0"
     rimraf "^2.2.8"
 
+fs-extra@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-3.0.1.tgz#3794f378c58b342ea7dbbb23095109c4b3b62291"
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^3.0.0"
+    universalify "^0.1.0"
+
 fs-extra@~1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-1.0.0.tgz#cd3ce5f7e7cb6145883fcae3191e9877f8587950"
@@ -2615,6 +2649,18 @@ getpass@^0.1.1:
   dependencies:
     assert-plus "^1.0.0"
 
+gh-pages@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/gh-pages/-/gh-pages-1.0.0.tgz#4a46f4c25439f7a2b7e6835504d4a49e949f04ca"
+  dependencies:
+    async "2.1.4"
+    base64url "^2.0.0"
+    commander "2.9.0"
+    fs-extra "^3.0.1"
+    globby "^6.1.0"
+    graceful-fs "4.1.11"
+    rimraf "^2.5.4"
+
 glob-base@^0.3.0:
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/glob-base/-/glob-base-0.3.0.tgz#dbb164f6221b1c0b1ccf82aea328b497df0ea3c4"
@@ -2675,6 +2721,16 @@ globby@^5.0.0:
     pify "^2.0.0"
     pinkie-promise "^2.0.0"
 
+globby@^6.1.0:
+  version "6.1.0"
+  resolved "https://registry.yarnpkg.com/globby/-/globby-6.1.0.tgz#f5a6d70e8395e21c858fb0489d64df02424d506c"
+  dependencies:
+    array-union "^1.0.1"
+    glob "^7.0.3"
+    object-assign "^4.0.1"
+    pify "^2.0.0"
+    pinkie-promise "^2.0.0"
+
 globule@^1.0.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/globule/-/globule-1.2.0.tgz#1dc49c6822dd9e8a2fa00ba2a295006e8664bd09"
@@ -2689,7 +2745,7 @@ good-listener@^1.2.2:
   dependencies:
     delegate "^3.1.2"
 
-graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.1.9:
+graceful-fs@4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.1.9:
   version "4.1.11"
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
 
@@ -3343,6 +3399,12 @@ jsonfile@^2.1.0:
   optionalDependencies:
     graceful-fs "^4.1.6"
 
+jsonfile@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-3.0.1.tgz#a5ecc6f65f53f662c4415c7675a0331d0992ec66"
+  optionalDependencies:
+    graceful-fs "^4.1.6"
+
 jsonify@~0.0.0:
   version "0.0.0"
   resolved "https://registry.yarnpkg.com/jsonify/-/jsonify-0.0.0.tgz#2c74b6ee41d93ca51b7b5aaee8f503631d252a73"
@@ -3642,6 +3704,10 @@ map-obj@^1.0.0, map-obj@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-1.0.1.tgz#d933ceb9205d82bdcf4886f6742bdc2b4dea146d"
 
+marked@^0.3.6:
+  version "0.3.6"
+  resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.6.tgz#b2c6c618fccece4ef86c4fc6cb8a7cbf5aeda8d7"
+
 math-expression-evaluator@^1.2.14:
   version "1.2.17"
   resolved "https://registry.yarnpkg.com/math-expression-evaluator/-/math-expression-evaluator-1.2.17.tgz#de819fdbcd84dccd8fae59c6aeb79615b9d266ac"
@@ -4613,7 +4679,7 @@ pretty-error@^2.0.2:
     renderkid "^2.0.1"
     utila "~0.4"
 
-prismjs@1.6.0:
+prismjs@1.6.0, prismjs@^1.6.0:
   version "1.6.0"
   resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.6.0.tgz#118d95fb7a66dba2272e343b345f5236659db365"
   optionalDependencies:
@@ -5146,7 +5212,7 @@ right-align@^0.1.1:
   dependencies:
     align-text "^0.1.1"
 
-rimraf@2, rimraf@^2.2.8, rimraf@^2.5.1, rimraf@^2.6.0, rimraf@^2.6.1:
+rimraf@2, rimraf@^2.2.8, rimraf@^2.5.1, rimraf@^2.5.4, rimraf@^2.6.0, rimraf@^2.6.1:
   version "2.6.2"
   resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.6.2.tgz#2ed8150d24a16ea8651e6d6ef0f47c4158ce7a36"
   dependencies:
@@ -5794,6 +5860,10 @@ tiny-emitter@^2.0.0:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/tiny-emitter/-/tiny-emitter-2.0.2.tgz#82d27468aca5ade8e5fd1e6d22b57dd43ebdfb7c"
 
+tinydate@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/tinydate/-/tinydate-1.0.0.tgz#20f31756a13959ef8c57ec133ba29b5ade042cac"
+
 tmp@0.0.31, tmp@0.0.x:
   version "0.0.31"
   resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.0.31.tgz#8f38ab9438e17315e5dbd8b3657e8bfb277ae4a7"
@@ -5856,6 +5926,10 @@ tweetnacl@^0.14.3, tweetnacl@~0.14.0:
   version "0.14.5"
   resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-0.14.5.tgz#5ae68177f192d4456269d108afa93ff8743f4f64"
 
+tweezer.js@^1.4.0:
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/tweezer.js/-/tweezer.js-1.4.0.tgz#206ff568ad34cf0e56a04307d99ffc52193d5045"
+
 type-check@~0.3.2:
   version "0.3.2"
   resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.3.2.tgz#5884cab512cf1d355e3fb784f30804b2b520db72"
@@ -5923,6 +5997,10 @@ uniqs@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/uniqs/-/uniqs-2.0.0.tgz#ffede4b36b25290696e6e165d4a59edb998e6b02"
 
+universalify@^0.1.0:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.1.tgz#fa71badd4437af4c148841e3b3b165f9e9e590b7"
+
 unpipe@1.0.0, unpipe@~1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec"
@@ -6351,6 +6429,10 @@ yeast@0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/yeast/-/yeast-0.1.2.tgz#008e06d8094320c372dbc2f8ed76a0ca6c8ac419"
 
+zoom-image@^0.1.4:
+  version "0.1.4"
+  resolved "https://registry.yarnpkg.com/zoom-image/-/zoom-image-0.1.4.tgz#faaf0a8051bb6726be60cf3dd6a335ec73f1e969"
+
 zrender@^3.6.1:
   version "3.6.1"
   resolved "https://registry.yarnpkg.com/zrender/-/zrender-3.6.1.tgz#362e8c4eb6c970a8d97c84daa8d65f37921b826b"