feat(docs): setup GitBook (#21)

.gitignore

@@ -1,3 +1,5 @@
+# GitBook
+/_book
 ### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Node.gitignore
 
 # Logs

README.md

@@ -67,10 +67,16 @@ Almin is a implementation of Read/Write Stack Architecture that is well-known as
     - How to test.
     - How to implement domain layer.
 
-## Tests
+## Running Tests
 
     npm test
 
+## Building Docs
+
+    npm run build:docs
+    # preview
+    npm run start:docs
+
 ## Contributing
 
 1. Fork it!

docs/SUMMARY.md → SUMMARY.md

@@ -1,6 +1,6 @@
-# SUMMARY
+## Table of Contents
 
-- What is this?
+- [What is Almin?](./docs/README.md)
 - [ ] Work flow
 - [ ] Data flow
 - [ ] Example: Counter
@@ -10,7 +10,8 @@
     - Repository
     - Store
     - State
-- [ ] Example
+- Example
+    - [Counter App](./docs/counter/README.md)
     - Immutability
     - Nesting UseCase
 - [ ] Testing

book.json

@@ -0,0 +1,15 @@
+{
+  "gitbook": "2.x.x",
+  "title": "Almin.js",
+  "description": "Flux/CQRS patterns for JavaScript app.",
+  "githubId": "almin/almin",
+  "author": "azu",
+  "plugins": [
+    "include-codeblock"
+  ],
+  "pluginsConfig": {
+  },
+  "structure": {
+    "summary": "./SUMMARY.md"
+  }
+}

docs/README.md

@@ -44,7 +44,15 @@ Almin has not perfect solution for an application, but we can write code thinkin
 
 We are going to learn two architecture(Flux/CQRS) using Almin :)
 
-## Tutorial
+## Table of Contents
+
+Truly [Table of Contents](../SUMMARY.md) is here :arrow_left:
+
+## Rough Table of Contents
+
+Rough version of Table of Contents.
+
+### Tutorial
 
 - [Creating Counter App](./counter/)
     - Apply Flux pattern to Almin

docs/counter/README.md

@@ -91,7 +91,7 @@ In flux:
 
 Return `IncrementalCounterUseCase` and add "dispatch increment event"
 
-[include, IncrementalCounterUseCase.js](../../example/counter/usecase/IncrementalCounterUseCase.js)
+[include, IncrementalCounterUseCase.js](../../example/counter/src/usecase/IncrementalCounterUseCase.js)
 
 A class inherited `UseCase` has `this.dispatch(payload);` method.
 
@@ -167,7 +167,7 @@ We have created `CounterState.js`.
 
 - receive "payload" and return state.
 
-[include, CounterState.js](../../example/counter/store/CounterState.js)
+[include, CounterState.js](../../example/counter/src/store/CounterState.js)
 
 You may have seen the pattern...
 Yes It is **reducer**!
@@ -185,7 +185,7 @@ Finally, we have added some code to `CounterStore`
 A class inherited `Store` has `this.emitChange();` method.
 It method is called and emit change to the subscribers(often View).
 
-[include, CounterStore.js](../../example/counter/store/CounterStore.js)
+[include, CounterStore.js](../../example/counter/src/store/CounterStore.js)
 
 ### Side note: Testing
 

package.json

@@ -22,6 +22,8 @@
     "test": "test"
   },
   "scripts": {
+    "start:docs": "gitbook serve",
+    "build:docs": "gitbook build",
     "build": "NODE_ENV=production babel src --out-dir lib --source-maps",
     "watch": "babel src --out-dir lib --watch --source-maps",
     "prepublish": "npm run --if-present build",
@@ -43,6 +45,8 @@
     "babel-preset-jsdoc-to-assert": "^1.0.1",
     "babel-preset-power-assert": "^1.0.0",
     "babel-register": "^6.7.2",
+    "gitbook-cli": "^2.1.3",
+    "gitbook-plugin-include-codeblock": "^1.8.2",
     "mocha": "^2.4.5",
     "power-assert": "^1.3.1",
     "textlint": "^6.3.0",