docs: skeleton

docs/index.md

@@ -5,7 +5,7 @@ Toshihiko is yet another simple Node.js ORM with cache layer.
     <span>Toshihiko</span>
 </div>
 
-[Installation](getting-started.md)
+[Installation](docs/getting-started.md)
 
 > It only support MySQL so far.
 

docs/misc/changelog.md

@@ -0,0 +1,182 @@
+<a name="0.8.3"></a>
+## [0.8.3](https://github.com/XadillaX/Toshihiko/compare/0.8.2...v0.8.3) (2016-07-29)
+
+
+
+<a name="0.8.2"></a>
+## [0.8.2](https://github.com/XadillaX/Toshihiko/compare/0.8.1...v0.8.2) (2016-06-19)
+
+### Bug Fixes
+
+* error when use string in query(field) ([be7b688](https://github.com/XadillaX/Toshihiko/commit/be7b688))
+
+<a name="0.8.1"></a>
+## [0.8.1](https://github.com/XadillaX/Toshihiko/compare/v0.7.7...v0.8.1) (2016-06-12)
+
+### Bug Fixes
+
+* **lib/query.js:** fix bug the model update and delete callback null ([dff7c57](https://github.com/XadillaX/Toshihiko/commit/dff7c57))
+* **test:** make test correct after updating shouldjs to 9.* ([2ab9410](https://github.com/XadillaX/Toshihiko/commit/2ab9410))
+
+<a name="0.8.0"></a>
+# [0.8.0](https://github.com/XadillaX/Toshihiko/compare/v0.7.7...v0.8.0) (2016-06-12)
+
+
+
+### Bug Fixes
+
+* **lib/query.js:** fix bug the model update and delete callback null ([dff7c57](https://github.com/XadillaX/Toshihiko/commit/dff7c57))
+* **test:** make test correct after updating shouldjs to 9.* ([2ab9410](https://github.com/XadillaX/Toshihiko/commit/2ab9410))
+
+
+
+<a name="0.7.7"></a>
+## [0.7.7](https://github.com/XadillaX/Toshihiko/compare/v0.7.6...v0.7.7) (2016-03-11)
+
+
+### Bug Fixes
+
+* **lib/yukari.js:** fix the bug memcache should be delete but not when update ([b599506](https://github.com/XadillaX/Toshihiko/commit/b599506))
+* **lib/yukari.js:** fix the bug: null is not equl to false(or 0, '') ([6fd7c12](https://github.com/XadillaX/Toshihiko/commit/6fd7c12))
+
+
+
+<a name="0.7.6"></a>
+## [0.7.6](https://github.com/XadillaX/Toshihiko/compare/v0.7.5...v0.7.6) (2016-03-09)
+
+
+### Bug Fixes
+
+* **lib/yukari.js:** add another condition branch with no insertId when insert ([f82f624](https://github.com/XadillaX/Toshihiko/commit/f82f624))
+
+
+
+<a name="0.7.5"></a>
+## [0.7.5](https://github.com/XadillaX/Toshihiko/compare/v0.7.4...v0.7.5) (2016-03-08)
+
+
+### Bug Fixes
+
+* **lib/field_type/datetime.js:** Datetime.toJSON "Invalid date" error when datetime value is null ([86dc5a8](https://github.com/XadillaX/Toshihiko/commit/86dc5a8))
+
+
+
+<a name="0.7.4"></a>
+## [0.7.4](https://github.com/XadillaX/Toshihiko/compare/v0.7.3...v0.7.4) (2016-03-02)
+
+
+
+
+<a name="0.7.3"></a>
+## [0.7.3](https://github.com/XadillaX/Toshihiko/compare/v0.7.2...v0.7.3) (2016-02-29)
+
+
+### Bug Fixes
+
+* fix #38 ([bdde107](https://github.com/XadillaX/Toshihiko/commit/bdde107)), closes [#38](https://github.com/XadillaX/Toshihiko/issues/38)
+
+### Features
+
+* add a AUTO_INCREMENT field in model ([cb8a871](https://github.com/XadillaX/Toshihiko/commit/cb8a871))
+* add a new optional column for field -> autoIncrement ([e891d6e](https://github.com/XadillaX/Toshihiko/commit/e891d6e))
+
+
+
+<a name="0.7.2"></a>
+## [0.7.2](https://github.com/XadillaX/Toshihiko/compare/v0.7.1...v0.7.2) (2016-01-20)
+
+### Bug Fixes
+
+* fix #34, Model.count 的时候，在 callback 函数里面 throw Error 会触发两次 callback ([e567060](https://github.com/XadillaX/Toshihiko/commit/e567060)), closes [#34](https://github.com/XadillaX/Toshihiko/issues/34)
+* use count to instead of result[0]['COUNT(0)'] ([c335b84](https://github.com/XadillaX/Toshihiko/commit/c335b84))
+
+### Features
+
+* add a test case for #34 ([57daa41](https://github.com/XadillaX/Toshihiko/commit/57daa41))
+* **package.json:** update denpendencies ([22ec1c2](https://github.com/XadillaX/Toshihiko/commit/22ec1c2))
+
+<a name="0.7.1"></a>
+## [0.7.1](https://github.com/XadillaX/Toshihiko/compare/v0.7.0...v0.7.1) (2016-01-09)
+
+### Features
+
+* add `updateByJson` method in Yukari ([d7fa632...1c19aa6](https://github.com/XadillaX/Toshihiko/compare/d7fa632...1c19aa6))
+* add test cases for `updateByJson` ([c0f2a29](https://github.com/XadillaX/Toshihiko/commit/c0f2a291661f4c89227ac5f63e20bff1eaef9e0a))
+
+# [0.7.0](https://github.com/XadillaX/Toshihiko/compare/0.6.4...v0.7.0) (2016-01-07)
+
+### Features
+
+* add commit message validation to git precommit hook ([8e178f2](https://github.com/XadillaX/Toshihiko/commit/8e178f2))
+* re-add toshihiko-memcached as the default cache layout ([a84f93c](https://github.com/XadillaX/Toshihiko/commit/a84f93c))
+* update package.json to v0.7.0 ([b57f469](https://github.com/XadillaX/Toshihiko/commit/b57f469))
+* use ghooks instead of precommit-hooks ([0c3ebd4](https://github.com/XadillaX/Toshihiko/commit/0c3ebd4))
+
+## 2016-01-05, Version 0.6.4, @XadillaX
+
+### Notable Changes
+
+  + Rename all `*.js` source files into underscore filenames. eg. `fieldType` to `field_type`. - see [#31](https://github.com/XadillaX/Toshihiko/pull/31)
+  + Fix a bug that generated an invalid SQL while use `Array` in `$neq`. - see [#32](http://github.com/XadillaX/Toshihiko/pull/32)
+
+### Commits
+  + [[df37bd062e](https://github.com/XadillaX/Toshihiko/commit/df37bd062e)] - Make the code more friendly with scope.
+  + [[c088f3f7eb](https://github.com/XadillaX/Toshihiko/commit/c088f3f7eb)] - Rename filenames to underscore ones.
+  + [[3b319f71c2](https://github.com/XadillaX/Toshihiko/commit/3b319f71c2)] - Change the require order in source files. (System > Denpendencies > Local)
+  + [[eda60efc38](https://github.com/XadillaX/Toshihiko/commit/eda60efc38)] - Fix a bug that generated an invalid SQL while use `Array` in `$neq`.
+
+## 2015-12-15, Version 0.6.3, @XadillaX
+
+### Notable Changes
+
+  + Cancel error when `update` in `Yukari` without change. - see [#9d222d5367](https://github.com/XadillaX/Toshihiko/commit/9d222d53677970375feb13e861cfc80bee265998)
+
+### Commits
+  + [[9d222d5367](https://github.com/XadillaX/Toshihiko/commit/9d222d5367)] - Cancel error when `update` in `Yukari` without change.
+  + [[466a4a59a4](https://github.com/XadillaX/Toshihiko/commit/466a4a59a4)] - Update dependencies.
+  + [[268f6b1418](https://github.com/XadillaX/Toshihiko/commit/268f6b1418)] - Update devDependencies.
+
+## 2015-11-24, Version 0.6.2, @Luicfer
+
+### Notable Changes
+
+  + Find in memcached first when `findById`. - see [#29](https://github.com/XadillaX/Toshihiko/pull/29)
+
+### Commits
+  + [[50b4a6e2c0](https://github.com/XadillaX/Toshihiko/commit/50b4a6e2c0)] - Optimize performance of `findById`.
+  + [[b04d36b173](https://github.com/XadillaX/Toshihiko/commit/b04d36b173)] - Add a new test case.
+  + [[b855545c1b](https://github.com/XadillaX/Toshihiko/commit/b855545c1b)] - Add precommit hook for git repo.
+
+## 2015-11-2, Version 0.6.1, @XadillaX
+
+### Notable Changes
+
+  + Add **0** field type support. - see [#27](https://github.com/XadillaX/Toshihiko/pull/27)
+
+### Commits
+  + [[fca5f18744](https://github.com/XadillaX/Toshihiko/commit/fca5f18744)] - Add **Boolean** field type support and test cases.
+  + [[7ee1c910cb](https://github.com/XadillaX/Toshihiko/commit/7ee1c910cb)] - Remove `npm-shrinkwrap.json`.
+
+# 2015-10-23, Version 0.6.0, @XadillaX
+
+### Notable Changes
+
++ Remove [SugarJs](http://sugarjs.com/) dependency, and use [lodash](https://lodash.com/) insteaded. (My supervisor told that do not use invasive package)
+  - Remove [SugarJs](http://sugarjs.com/) - see [#26](https://github.com/XadillaX/Toshihiko/pull/26)
+  - Fix migration bugs - see [7458203](https://github.com/XadillaX/Toshihiko/commit/7458203)
+
+### Commits
+  + [[b7c230455e](https://github.com/XadillaX/Toshihiko/commit/b7c230455e)] - Add the `Makefile`.
+  + [[91b05b0532](https://github.com/XadillaX/Toshihiko/commit/91b05b0532)] - Remove [SugarJs](http://sugarjs.com/) dependency, and use [lodash](https://lodash.com/) insteaded.
+  + [[74582035e2](https://github.com/XadillaX/Toshihiko/commit/74582035e2)] - Fix migration bugs.
+  + [[aa90281628](https://github.com/XadillaX/Toshihiko/commit/aa90281628), [58800abfdb](https://github.com/XadillaX/Toshihiko/commit/58800abfdb), [586e7eaa61](https://github.com/XadillaX/Toshihiko/commit/586e7eaa61), [5de52a4226](https://github.com/XadillaX/Toshihiko/commit/5de52a4226), [3f07a179d9](https://github.com/XadillaX/Toshihiko/commit/3f07a179d9), [1ff2887395](1ff2887395), [e506ee9254](https://github.com/XadillaX/Toshihiko/commit/e506ee9254)] - Update some test cases.
+
+## 2015-10-19, Version 0.5.5, @XadillaX
+
+### Notable Changes
+
++ Add warning output when defining a model without primary key(s) because of query cache optimization.
+
+### Commits
+
++ [3a067ee30e] - Add warning output when defining a model without primary key(s).

mkdocs.yml

@@ -9,8 +9,18 @@ extra_css:
 pages:
   - Home: index.md
   - Documentation:
-      - Getting Started: getting-started.md
-      - Model:
-        - Definition: model/definition.md
-        - Usage: model/usage.md
-      - Querying: querying.md
+    - Getting Started: docs/getting-started.md
+    - Model:
+      - Definition: docs/model/definition.md
+      - Usage: docs/model/usage.md
+    - Querying: docs/querying.md
+    - Instance (Yukari): docs/yukari.md
+    - Data Types: docs/type.md
+  - API:
+    - Toshihiko: api/toshihiko.md
+    - Model: api/model.md
+    - Yukari: api/yukari.md
+    - Data Types: api/type.md
+  - Misc:
+    - Changelog: misc/changelog.md
+    - Imprint: misc/imprint.md

package.json

@@ -70,7 +70,7 @@
       "path": "./node_modules/cz-conventional-changelog"
     },
     "ghooks": {
-      "pre-commit": "npm run lint && npm run validate",
+      "pre-commit": "npm run lint && npm run validate && rm docs/misc/changelog.md && cp CHANGELOG.md docs/misc/changelog.md && git add docs/misc/changelog.md",
       "commit-msg": "npm run commit-msg",
       "pre-push": "npm test"
     }