⭐ new: setup documentation with gitbook

meta.js

@@ -24,11 +24,16 @@ module.exports = {
     e2e: {
       type: 'confirm',
       message: 'Setup e2e tests?'
+    },
+    gitbook: {
+      type: 'confirm',
+      message: 'Setup gitbook documentaion?'
     }
   },
   filters: {
     "examples/**/*": 'e2e',
-    "test/e2e/**/*": 'e2e'
+    "test/e2e/**/*": 'e2e',
+    "docs/**/**": 'gitbook'
   },
   helpers: {
     nowYear: function () {
@@ -42,6 +47,11 @@ module.exports = {
       const startPosition = author.indexOf('<')
       const endPosition = author.indexOf('>')
       return author.slice(startPosition + 1, endPosition)
+    },
+    classify: function (str) {
+      return str.replace(/(?:^|[-_\/])(\w)/g, function (_, c) {
+        return c ? c.toUpperCase() : ''
+      })
     }
   }
 }

template/README.md

@@ -2,6 +2,10 @@
 
 {{ description }}
 
+{{#gitbook}}{{#unless_eq githubAccount ""}}
+## Documentation
+See [here](http://{{ githubAccount }}.github.io/{{ name }}/)
+{{/unless_eq}}{{/gitbook}}
 
 ## Build Setup
 

template/docs/LANGS.md

@@ -0,0 +1 @@
+* [English](en/)

template/docs/book.json

@@ -0,0 +1,21 @@
+{
+  "gitbook": "2.x.x",
+  "plugins": ["edit-link", "github", "advanced-emoji"],
+  "pluginsConfig": {
+    {{#unless_eq githubAccount ""}}
+    "edit-link": {
+      "base": "https://github.com/{{ githubAccount }}/{{ name }}/tree/master/docs",
+      "label": "Edit This Page"
+    },
+    "github": {
+      "url": "https://github.com/{{ githubAccount }}/{{ name }}/"
+    }
+    {{/unless_eq}}
+  },
+  "links": {
+    "sharing": {
+      "facebook": false,
+      "twitter": false
+    }
+  }
+}

template/docs/en/README.md

@@ -0,0 +1 @@
+SUMMARY.md

template/docs/en/SUMMARY.md

@@ -0,0 +1,9 @@
+# {{ name }} documentation
+
+> {{ description }}
+
+{{#unless_eq githubAccount ""}}
+**[CHANGELOG](https://github.com/{{ githubAccount }}/{{ name }}/blob/master/CHANGELOG.md)**
+{{/unless_eq}}
+
+- [Installation](installation.md)

template/docs/en/installation.md

@@ -0,0 +1,34 @@
+# Installation
+
+{{#unless_eq githubAccount ""}}
+## Direct Download
+
+See [dist folder](https://github.com/{{ githubAccount }}/{{ name }}/tree/master/dist). Note the dist files are always the latest stable - it's not update-to-date with the master branch source.
+{{/unless_eq}}
+
+## NPM
+
+### stable version
+
+    $ npm install {{ name }}
+
+{{#unless_eq githubAccount ""}}
+### development version
+
+    $ git clone https://github.com/{{ githubAccount }}/{{ name }}.git node_modules/{{ name }}
+    $ cd node_modules/{{ name }}
+    $ npm install
+    $ npm run build
+
+When used in CommonJS, you must explicitly install the validator via `Vue.use()`:
+{{/unless_eq}}
+
+
+```javascript
+const Vue = require('vue')
+const {{ classify name }} = require('{{ name }}')
+
+Vue.use({{ classify name }})
+```
+
+You don't need to do this when using the standalone build, as it installs itself automatically.

template/package.json

@@ -22,6 +22,9 @@
     "eslint": "^2.8.0",
     "eslint-config-vue": "^1.0.0",
     "eslint-loader": "^1.3.0",
+    {{#gitbook}}
+    "gitbook-cli": "^2.2.0",
+    {{/gitbook}}
     "jasmine": "^2.4.1",
     "jasmine-core": "^2.4.1",
     "json-loader": "^0.5.4",
@@ -78,7 +81,16 @@
   "scripts": {
     "build": "NODE_ENV=production node config/build.js",
     "dev": "webpack-dev-server --quiet --config config/webpack.dev.conf.js --host 0.0.0.0",
+    {{#gitbook}}
+    "docs": "cd docs && gitbook serve",
+    {{#unless_eq githubAccount ""}}
+    "docs:deploy": "cd docs && rm -rf _book && gitbook build && cd _book && git init && git add -A && git commit -m 'update book' && git push -f git@github.com:{{ githubAccount }}/{{ name }}.git master:gh-pages && cd .. && cd ..",
+    {{/unless_eq}}
+    {{/gitbook}}
     "lint": "eslint src test config",
+    {{#gitbook}}
+    "postinstall": "cd docs && gitbook install && cd ..",
+    {{/gitbook}}
     "test": "npm run lint && npm run test:unit{{#e2e}} && npm run test:e2e{{/e2e}}",
     "test:cover": "NODE_ENV=development karma start config/karma.cover.conf.js",
     {{#e2e}}