chore: add changelog 4.3.9

* fix scroll issue in IE

* add meta tag for IE browser

.eslintignore

@@ -0,0 +1,3 @@
+.git/
+packages/docsify-server-renderer/build.js
+node_modules

.eslintrc

@@ -1,6 +1,15 @@
 {
-  "extends": ["vue"],
+  "extends": [
+    "vue"
+  ],
+  "parserOptions": {
+      "ecmaVersion": 8
+    },
+  "env": {
+    "browser": true
+  },
   "globals": {
-    "XMLHttpRequest": true
+    "Docsify": true,
+    "$docsify": true
   }
 }

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Please makes sure these boxes are checked before submitting your PR, thank you!
+
+* [ ] Make sure you are merging your commits to `master` branch.
+* [ ] Add some descriptions and refer relative issues for you PR.
+* [ ] DO NOT include files inside lib directory.

.gitignore

@@ -1,3 +1,4 @@
 *.log
+.DS_Store
+/themes
 node_modules
-yarn.lock

.npmignore

@@ -0,0 +1,5 @@
+.eslintignore
+.eslintrc
+.github/
+.gitignore
+.travis.yml

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "prettier.eslintIntegration": true
+}

CHANGELOG.md

@@ -0,0 +1,399 @@
+<a name="4.3.9"></a>
+## [4.3.9](https://github.com/QingWei-Li/docsify/compare/v4.3.8...v4.3.9) (2017-10-11)
+
+
+### Bug Fixes
+
+* scroll issue in IE ([#275](https://github.com/QingWei-Li/docsify/issues/275)) ([3e94cb6](https://github.com/QingWei-Li/docsify/commit/3e94cb6))
+
+
+
+<a name="4.3.8"></a>
+## [4.3.8](https://github.com/QingWei-Li/docsify/compare/v4.3.7...v4.3.8) (2017-10-07)
+
+
+### Bug Fixes
+
+* **slugify:** GitHub compatible heading links, fixed [#272](https://github.com/QingWei-Li/docsify/issues/272) ([9b4e666](https://github.com/QingWei-Li/docsify/commit/9b4e666))
+
+
+
+<a name="4.3.7"></a>
+## [4.3.7](https://github.com/QingWei-Li/docsify/compare/v4.3.6...v4.3.7) (2017-10-02)
+
+
+### Bug Fixes
+
+* **slugify:** GitHub compatible heading links, fixed [#267](https://github.com/QingWei-Li/docsify/issues/267) ([c195d2d](https://github.com/QingWei-Li/docsify/commit/c195d2d))
+
+
+
+<a name="4.3.6"></a>
+## [4.3.6](https://github.com/QingWei-Li/docsify/compare/v4.3.5...v4.3.6) (2017-09-21)
+
+
+### Bug Fixes
+
+* style for codesponsor plugin ([08afec7](https://github.com/QingWei-Li/docsify/commit/08afec7))
+
+
+
+<a name="4.3.5"></a>
+## [4.3.5](https://github.com/QingWei-Li/docsify/compare/v4.3.4...v4.3.5) (2017-09-20)
+
+
+### Bug Fixes
+
+* missed symbol ([#254](https://github.com/QingWei-Li/docsify/issues/254)) ([6c702d3](https://github.com/QingWei-Li/docsify/commit/6c702d3))
+
+
+### Features
+
+* **plugin:** add codesponsor plugin ([46ac4c3](https://github.com/QingWei-Li/docsify/commit/46ac4c3))
+
+
+
+<a name="4.3.4"></a>
+## [4.3.4](https://github.com/QingWei-Li/docsify/compare/v4.3.3...v4.3.4) (2017-09-07)
+
+
+### Bug Fixes
+
+* scroll position issue, fixed [#234](https://github.com/QingWei-Li/docsify/issues/234) ([388ed3d](https://github.com/QingWei-Li/docsify/commit/388ed3d))
+
+
+
+<a name="4.3.3"></a>
+## [4.3.3](https://github.com/QingWei-Li/docsify/compare/v4.3.2...v4.3.3) (2017-09-06)
+
+
+### Bug Fixes
+
+* **buble.css:** tweaks code block style, fixed [#249](https://github.com/QingWei-Li/docsify/issues/249) ([9d43051](https://github.com/QingWei-Li/docsify/commit/9d43051))
+
+
+### Features
+
+* add doc for react and vue demo box plugin ([#247](https://github.com/QingWei-Li/docsify/issues/247)) ([f0aca19](https://github.com/QingWei-Li/docsify/commit/f0aca19))
+
+
+
+<a name="4.3.2"></a>
+## [4.3.2](https://github.com/QingWei-Li/docsify/compare/v4.3.1...v4.3.2) (2017-09-01)
+
+
+### Bug Fixes
+
+* sidebar highlight ([f82f419](https://github.com/QingWei-Li/docsify/commit/f82f419))
+
+
+### Features
+
+* add Edit on github plugin (thanks [@njleonzhang](https://github.com/njleonzhang)) ([a0e1ea8](https://github.com/QingWei-Li/docsify/commit/a0e1ea8))
+
+
+
+<a name="4.3.1"></a>
+## [4.3.1](https://github.com/QingWei-Li/docsify/compare/v4.2.9...v4.3.1) (2017-08-30)
+
+
+### Features
+
+* **markdown:** supports mermaid [#137](https://github.com/QingWei-Li/docsify/issues/137) ([f4800e0](https://github.com/QingWei-Li/docsify/commit/f4800e0))
+
+
+
+<a name="4.3.0"></a>
+# [4.3.0](https://github.com/QingWei-Li/docsify/compare/v4.2.9...v4.3.0) (2017-08-17)
+
+
+### Features
+
+* **markdown:** supports mermaid [#137](https://github.com/QingWei-Li/docsify/issues/137) ([f4800e0](https://github.com/QingWei-Li/docsify/commit/f4800e0))
+
+
+
+<a name="4.2.9"></a>
+## [4.2.9](https://github.com/QingWei-Li/docsify/compare/v4.2.8...v4.2.9) (2017-08-15)
+
+
+### Bug Fixes
+
+* ensure document ready before init Docsify [#233](https://github.com/QingWei-Li/docsify/issues/233)
+
+<a name="4.2.8"></a>
+## [4.2.8](https://github.com/QingWei-Li/docsify/compare/v4.2.7...v4.2.8) (2017-08-10)
+
+
+### Features
+
+* **compiler:** support for setting target attribute for link, fixed [#230](https://github.com/QingWei-Li/docsify/issues/230) ([7f270f9](https://github.com/QingWei-Li/docsify/commit/7f270f9))
+
+
+
+<a name="4.2.7"></a>
+## [4.2.7](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.7) (2017-08-05)
+
+
+### Bug Fixes
+
+* **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+* **style:** nowrap => pre-wrap, fixed [#228](https://github.com/QingWei-Li/docsify/issues/228) ([a88252c](https://github.com/QingWei-Li/docsify/commit/a88252c))
+
+
+
+<a name="4.2.6"></a>
+## [4.2.6](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.6) (2017-07-27)
+
+
+### Bug Fixes
+
+* **css:** hide the nav when the content has not yet been loaded ([1fa1619](https://github.com/QingWei-Li/docsify/commit/1fa1619))
+* **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+
+
+
+<a name="4.2.4"></a>
+## [4.2.4](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.4) (2017-07-26)
+
+
+### Bug Fixes
+
+* **render:** Remove getRootNode to be compatible with the lower version of Chrome, fixed [#225](https://github.com/QingWei-Li/docsify/issues/225) ([b8dd346](https://github.com/QingWei-Li/docsify/commit/b8dd346))
+
+<a name="4.2.3"></a>
+## [4.2.3](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.3) (2017-07-26)
+
+
+### Features
+
+* **search:** Supports the max depth of the search headline, fixed [#223](https://github.com/QingWei-Li/docsify/issues/223), resolve [#129](https://github.com/QingWei-Li/docsify/issues/129) ([b7b589b](https://github.com/QingWei-Li/docsify/commit/b7b589b))
+
+
+
+<a name="4.2.2"></a>
+## [4.2.2](https://github.com/QingWei-Li/docsify/compare/v4.2.1...v4.2.2) (2017-07-24)
+
+
+### Bug Fixes
+
+* style rerender due to setting themeColor ([17ff3d1](https://github.com/QingWei-Li/docsify/commit/17ff3d1))
+
+
+
+<a name="4.2.1"></a>
+## [4.2.1](https://github.com/QingWei-Li/docsify/compare/v4.2.0...v4.2.1) (2017-07-19)
+
+- give the navbar some line-height (#216)
+- Remove unnecessary moduleName option from rollup config for plugins (#209)
+
+<a name="4.2.0"></a>
+# [4.2.0](https://github.com/QingWei-Li/docsify/compare/v4.1.14...v4.2.0) (2017-07-10)
+
+
+### Bug Fixes
+
+* not found page ([9af8559](https://github.com/QingWei-Li/docsify/commit/9af8559))
+
+
+### Features
+
+* alias option supports regexp, resolve [#183](https://github.com/QingWei-Li/docsify/issues/183) ([c4aa22c](https://github.com/QingWei-Li/docsify/commit/c4aa22c))
+* ignore to compiled link, fixed [#203](https://github.com/QingWei-Li/docsify/issues/203) ([#204](https://github.com/QingWei-Li/docsify/issues/204)) ([2e00f4c](https://github.com/QingWei-Li/docsify/commit/2e00f4c))
+
+
+
+<a name="4.1.14"></a>
+## [4.1.14](https://github.com/QingWei-Li/docsify/compare/v4.1.13...v4.1.14) (2017-06-24)
+
+
+### Bug Fixes
+
+* get file path, fixed jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070 ([e8117e5](https://github.com/QingWei-Li/docsify/commit/e8117e5)), closes [jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070](https://github.com/jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13/issues/commitcomment-22427070)
+
+
+### Features
+
+* add context attribute, fixed [#191](https://github.com/QingWei-Li/docsify/issues/191) ([ce0e9ac](https://github.com/QingWei-Li/docsify/commit/ce0e9ac))
+
+
+
+<a name="4.1.13"></a>
+## [4.1.13](https://github.com/QingWei-Li/docsify/compare/v4.1.12...v4.1.13) (2017-06-11)
+
+
+
+<a name="4.1.12"></a>
+## [4.1.12](https://github.com/QingWei-Li/docsify/compare/v4.1.11...v4.1.12) (2017-06-03)
+
+
+### Bug Fixes
+
+* **render:** ubtitle in side bar shows undefined, fixed [#182](https://github.com/QingWei-Li/docsify/issues/182) ([d087d57](https://github.com/QingWei-Li/docsify/commit/d087d57))
+
+
+
+<a name="4.1.11"></a>
+## [4.1.11](https://github.com/QingWei-Li/docsify/compare/v4.1.10...v4.1.11) (2017-06-02)
+
+
+### Bug Fixes
+
+* **compiler:** force reset toc when rendering sidebar fixed [#181](https://github.com/QingWei-Li/docsify/issues/181) ([ccf4c7c](https://github.com/QingWei-Li/docsify/commit/ccf4c7c))
+* **render:** autoHeader does not work ([1304d2e](https://github.com/QingWei-Li/docsify/commit/1304d2e))
+
+
+
+<a name="4.1.10"></a>
+## [4.1.10](https://github.com/QingWei-Li/docsify/compare/v4.1.9...v4.1.10) (2017-06-02)
+
+
+### Bug Fixes
+
+* **hash:** hash routing crashes when url has querystring ([6d48ce1](https://github.com/QingWei-Li/docsify/commit/6d48ce1))
+
+
+
+<a name="4.1.9"></a>
+## [4.1.9](https://github.com/QingWei-Li/docsify/compare/v4.1.8...v4.1.9) (2017-05-31)
+
+
+### Bug Fixes
+
+* can't render toc on first load ([d9b487e](https://github.com/QingWei-Li/docsify/commit/d9b487e))
+* **lifecycle:** continue to handle data ([955d3d5](https://github.com/QingWei-Li/docsify/commit/955d3d5))
+* **render:** broken name link, fixed [#167](https://github.com/QingWei-Li/docsify/issues/167) ([91b66a5](https://github.com/QingWei-Li/docsify/commit/91b66a5))
+
+
+
+<a name="4.1.8"></a>
+## [4.1.8](https://github.com/QingWei-Li/docsify/compare/v4.1.7...v4.1.8) (2017-05-31)
+
+
+### Bug Fixes
+
+* auto replace version ([22b50f0](https://github.com/QingWei-Li/docsify/commit/22b50f0))
+* update edit button demo ([ec887c1](https://github.com/QingWei-Li/docsify/commit/ec887c1))
+
+
+### Features
+
+* add edit button demo ([a64cee1](https://github.com/QingWei-Li/docsify/commit/a64cee1))
+* add edit button demo, close [#162](https://github.com/QingWei-Li/docsify/issues/162) ([036fdac](https://github.com/QingWei-Li/docsify/commit/036fdac))
+
+
+
+<a name="4.1.7"></a>
+## [4.1.7](https://github.com/QingWei-Li/docsify/compare/v4.1.6...v4.1.7) (2017-05-30)
+
+
+### Bug Fixes
+
+* **ssr:** clean files ([0014895](https://github.com/QingWei-Li/docsify/commit/0014895))
+
+
+
+<a name="4.1.6"></a>
+## [4.1.6](https://github.com/QingWei-Li/docsify/compare/v4.1.5...v4.1.6) (2017-05-30)
+
+
+### Bug Fixes
+
+* **ssr:** add debug ([6b9e092](https://github.com/QingWei-Li/docsify/commit/6b9e092))
+
+
+
+<a name="4.1.5"></a>
+## [4.1.5](https://github.com/QingWei-Li/docsify/compare/v4.1.4...v4.1.5) (2017-05-30)
+
+
+### Bug Fixes
+
+* **ssr:** missing  package ([6db8c9e](https://github.com/QingWei-Li/docsify/commit/6db8c9e))
+
+
+
+<a name="4.1.4"></a>
+## [4.1.4](https://github.com/QingWei-Li/docsify/compare/v4.1.3...v4.1.4) (2017-05-30)
+
+
+### Bug Fixes
+
+* **ssr:** file path ([79a83bc](https://github.com/QingWei-Li/docsify/commit/79a83bc))
+
+
+
+<a name="4.1.3"></a>
+## [4.1.3](https://github.com/QingWei-Li/docsify/compare/v4.1.2...v4.1.3) (2017-05-30)
+
+
+### Bug Fixes
+
+* update babel config ([9825db4](https://github.com/QingWei-Li/docsify/commit/9825db4))
+
+
+
+<a name="4.1.2"></a>
+## [4.1.2](https://github.com/QingWei-Li/docsify/compare/v4.1.1...v4.1.2) (2017-05-30)
+
+
+### Bug Fixes
+
+* update babel config ([80dba19](https://github.com/QingWei-Li/docsify/commit/80dba19))
+
+
+
+<a name="4.1.1"></a>
+## [4.1.1](https://github.com/QingWei-Li/docsify/compare/v4.1.0...v4.1.1) (2017-05-30)
+
+
+### Bug Fixes
+
+* build for ssr package ([4cb20a5](https://github.com/QingWei-Li/docsify/commit/4cb20a5))
+* remove history mode ([0e74e6c](https://github.com/QingWei-Li/docsify/commit/0e74e6c))
+
+
+
+<a name="4.1.0"></a>
+# [4.1.0](https://github.com/QingWei-Li/docsify/compare/v4.0.2...v4.1.0) (2017-05-30)
+
+
+
+<a name="4.0.2"></a>
+## [4.0.2](https://github.com/QingWei-Li/docsify/compare/v4.0.1...v4.0.2) (2017-05-30)
+
+
+### Bug Fixes
+
+* basePath for history mode ([fc1cd3f](https://github.com/QingWei-Li/docsify/commit/fc1cd3f))
+
+
+
+<a name="4.0.1"></a>
+## [4.0.1](https://github.com/QingWei-Li/docsify/compare/v4.0.0...v4.0.1) (2017-05-29)
+
+
+### Bug Fixes
+
+* **ssr:** remove context ([4626157](https://github.com/QingWei-Li/docsify/commit/4626157))
+* lint ([b764b6e](https://github.com/QingWei-Li/docsify/commit/b764b6e))
+
+
+
+<a name="4.0.0"></a>
+# [4.0.0](https://github.com/QingWei-Li/docsify/compare/v3.7.3...v4.0.0) (2017-05-29)
+
+
+### Bug Fixes
+
+* **render:** init event in ssr ([eba1c98](https://github.com/QingWei-Li/docsify/commit/eba1c98))
+* lint ([1f4514d](https://github.com/QingWei-Li/docsify/commit/1f4514d))
+
+
+### Features
+
+* finish ssr ([3444884](https://github.com/QingWei-Li/docsify/commit/3444884))
+* init ocsify-server-renderer ([6dea685](https://github.com/QingWei-Li/docsify/commit/6dea685))
+* support history mode ([f095eb8](https://github.com/QingWei-Li/docsify/commit/f095eb8))
+
+

HISTORY.md

@@ -0,0 +1,736 @@
+
+<a name="3.7.3"></a>
+## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
+
+
+### Bug Fixes
+
+* **render:** find => filter ([eca3368](https://github.com/QingWei-Li/docsify/commit/eca3368))
+
+
+
+<a name="3.7.2"></a>
+## [3.7.2](https://github.com/QingWei-Li/docsify/compare/v3.7.1...v3.7.2) (2017-05-19)
+
+
+
+<a name="3.7.1"></a>
+## [3.7.1](https://github.com/QingWei-Li/docsify/compare/v3.7.0...v3.7.1) (2017-05-19)
+
+
+### Bug Fixes
+
+* docsify-updated is undefined ([b2b4742](https://github.com/QingWei-Li/docsify/commit/b2b4742))
+
+
+
+<a name="3.7.0"></a>
+# [3.7.0](https://github.com/QingWei-Li/docsify/compare/v3.6.6...v3.7.0) (2017-05-16)
+
+
+### Features
+
+* add docsify-updated, close [#158](https://github.com/QingWei-Li/docsify/issues/158) ([d2be5ae](https://github.com/QingWei-Li/docsify/commit/d2be5ae))
+* add externalLinkTarget, close [#149](https://github.com/QingWei-Li/docsify/issues/149) ([2d73285](https://github.com/QingWei-Li/docsify/commit/2d73285))
+
+
+
+<a name="3.6.6"></a>
+## [3.6.6](https://github.com/QingWei-Li/docsify/compare/v3.6.5...v3.6.6) (2017-05-06)
+
+
+### Features
+
+* support query string for the search, fixed [#156](https://github.com/QingWei-Li/docsify/issues/156) ([da75d70](https://github.com/QingWei-Li/docsify/commit/da75d70))
+
+
+
+<a name="3.6.5"></a>
+## [3.6.5](https://github.com/QingWei-Li/docsify/compare/v3.6.4...v3.6.5) (2017-04-28)
+
+
+### Bug Fixes
+
+* **util:** fix crash, fixed [#154](https://github.com/QingWei-Li/docsify/issues/154) ([51832d3](https://github.com/QingWei-Li/docsify/commit/51832d3))
+
+
+
+<a name="3.6.4"></a>
+## [3.6.4](https://github.com/QingWei-Li/docsify/compare/v3.6.3...v3.6.4) (2017-04-28)
+
+
+### Bug Fixes
+
+* **util:** correctly clean up duplicate slashes, fixed [#153](https://github.com/QingWei-Li/docsify/issues/153) ([76c041a](https://github.com/QingWei-Li/docsify/commit/76c041a))
+
+
+
+<a name="3.6.3"></a>
+## [3.6.3](https://github.com/QingWei-Li/docsify/compare/v3.6.2...v3.6.3) (2017-04-25)
+
+
+### Bug Fixes
+
+* **external-script:** script attrs ([2653849](https://github.com/QingWei-Li/docsify/commit/2653849))
+
+
+
+<a name="3.6.2"></a>
+## [3.6.2](https://github.com/QingWei-Li/docsify/compare/v3.6.0...v3.6.2) (2017-04-12)
+
+
+### Features
+
+* **event:** Collapse the sidebar when click outside element in the small screen ([9b7e5f5](https://github.com/QingWei-Li/docsify/commit/9b7e5f5))
+* **external-script:** detect more than one script dom, fixed [#146](https://github.com/QingWei-Li/docsify/issues/146) ([94d6603](https://github.com/QingWei-Li/docsify/commit/94d6603))
+
+
+
+<a name="3.6.0"></a>
+# [3.6.0](https://github.com/QingWei-Li/docsify/compare/v3.5.2...v3.6.0) (2017-04-09)
+
+
+### Features
+
+* **render:** add mergeNavbar option, close [#125](https://github.com/QingWei-Li/docsify/issues/125), [#124](https://github.com/QingWei-Li/docsify/issues/124) ([#145](https://github.com/QingWei-Li/docsify/issues/145)) ([9220523](https://github.com/QingWei-Li/docsify/commit/9220523))
+
+
+
+<a name="3.5.2"></a>
+## [3.5.2](https://github.com/QingWei-Li/docsify/compare/v3.5.1...v3.5.2) (2017-04-05)
+
+
+
+<a name="3.5.1"></a>
+## [3.5.1](https://github.com/QingWei-Li/docsify/compare/v3.5.0...v3.5.1) (2017-03-25)
+
+
+### Bug Fixes
+
+* .md file extension regex ([594299f](https://github.com/QingWei-Li/docsify/commit/594299f))
+
+
+
+<a name="3.5.0"></a>
+# [3.5.0](https://github.com/QingWei-Li/docsify/compare/v3.4.4...v3.5.0) (2017-03-25)
+
+
+### Bug Fixes
+
+* adjust display on small screens ([bf35471](https://github.com/QingWei-Li/docsify/commit/bf35471))
+* navbar labels for German ([b022aaf](https://github.com/QingWei-Li/docsify/commit/b022aaf))
+
+
+### Features
+
+* **route:** auto remove .md extension ([8f11653](https://github.com/QingWei-Li/docsify/commit/8f11653))
+
+
+
+<a name="3.4.4"></a>
+## [3.4.4](https://github.com/QingWei-Li/docsify/compare/v3.4.3...v3.4.4) (2017-03-17)
+
+
+### Bug Fixes
+
+* **search:** fix input style ([2d6a51b](https://github.com/QingWei-Li/docsify/commit/2d6a51b))
+
+
+
+<a name="3.4.3"></a>
+## [3.4.3](https://github.com/QingWei-Li/docsify/compare/v3.4.2...v3.4.3) (2017-03-16)
+
+
+
+<a name="3.4.2"></a>
+## [3.4.2](https://github.com/QingWei-Li/docsify/compare/v3.4.1...v3.4.2) (2017-03-11)
+
+
+### Features
+
+* **emojify:** add no-emoji option ([3aef37a](https://github.com/QingWei-Li/docsify/commit/3aef37a))
+
+
+
+<a name="3.4.1"></a>
+## [3.4.1](https://github.com/QingWei-Li/docsify/compare/v3.4.0...v3.4.1) (2017-03-10)
+
+
+### Bug Fixes
+
+* **dom:** Disable the dom cache when vue is present, fixed [#119](https://github.com/QingWei-Li/docsify/issues/119) ([b9a7275](https://github.com/QingWei-Li/docsify/commit/b9a7275))
+
+
+
+<a name="3.4.0"></a>
+# [3.4.0](https://github.com/QingWei-Li/docsify/compare/v3.3.0...v3.4.0) (2017-03-09)
+
+
+### Features
+
+* **zoom-image:** add plugin ([50fa6fc](https://github.com/QingWei-Li/docsify/commit/50fa6fc))
+
+
+
+<a name="3.3.0"></a>
+# [3.3.0](https://github.com/QingWei-Li/docsify/compare/v3.2.0...v3.3.0) (2017-03-07)
+
+
+
+<a name="3.2.0"></a>
+# [3.2.0](https://github.com/QingWei-Li/docsify/compare/v3.1.2...v3.2.0) (2017-02-28)
+
+
+### Bug Fixes
+
+* **fetch:** load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100) ([f3fc596](https://github.com/QingWei-Li/docsify/commit/f3fc596))
+* **render:** Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106) ([0d59ee9](https://github.com/QingWei-Li/docsify/commit/0d59ee9))
+
+
+### Features
+
+* **search:** Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103) ([d3c9fbd](https://github.com/QingWei-Li/docsify/commit/d3c9fbd))
+
+
+
+<a name="3.1.2"></a>
+## [3.1.2](https://github.com/QingWei-Li/docsify/compare/v3.1.1...v3.1.2) (2017-02-27)
+
+
+
+<a name="3.1.1"></a>
+## [3.1.1](https://github.com/QingWei-Li/docsify/compare/v3.1.0...v3.1.1) (2017-02-24)
+
+
+### Bug Fixes
+
+* **render:** custom cover background image ([8f9bf29](https://github.com/QingWei-Li/docsify/commit/8f9bf29))
+* **search:** dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102) ([507d9e8](https://github.com/QingWei-Li/docsify/commit/507d9e8))
+* **tpl:** extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101) ([d67d25f](https://github.com/QingWei-Li/docsify/commit/d67d25f))
+
+
+
+<a name="3.1.0"></a>
+# [3.1.0](https://github.com/QingWei-Li/docsify/compare/v3.0.5...v3.1.0) (2017-02-22)
+
+
+### Bug Fixes
+
+* **search:** incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90) ([b8a3d8f](https://github.com/QingWei-Li/docsify/commit/b8a3d8f))
+* **sw:** update white list ([f2975a5](https://github.com/QingWei-Li/docsify/commit/f2975a5))
+
+
+### Features
+
+* **emoji:** add emoji plugin ([855c450](https://github.com/QingWei-Li/docsify/commit/855c450))
+
+
+
+<a name="3.0.5"></a>
+## [3.0.5](https://github.com/QingWei-Li/docsify/compare/v3.0.4...v3.0.5) (2017-02-21)
+
+
+### Bug Fixes
+
+* **event:** highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86) ([2a1157a](https://github.com/QingWei-Li/docsify/commit/2a1157a))
+* **gen-tree:** cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88) ([3394ebb](https://github.com/QingWei-Li/docsify/commit/3394ebb))
+* **layout.css:** loading style ([42b2dba](https://github.com/QingWei-Li/docsify/commit/42b2dba))
+
+
+### Features
+
+* **pwa:** add sw.js ([f7111b5](https://github.com/QingWei-Li/docsify/commit/f7111b5))
+
+
+
+<a name="3.0.4"></a>
+## [3.0.4](https://github.com/QingWei-Li/docsify/compare/v3.0.3...v3.0.4) (2017-02-20)
+
+
+### Bug Fixes
+
+* **render:** disable rendering sub list when loadSidebar is false ([35dd2e1](https://github.com/QingWei-Li/docsify/commit/35dd2e1))
+* **render:** execute script ([780c1e5](https://github.com/QingWei-Li/docsify/commit/780c1e5))
+
+
+
+<a name="3.0.3"></a>
+## [3.0.3](https://github.com/QingWei-Li/docsify/compare/v3.0.2...v3.0.3) (2017-02-19)
+
+
+
+<a name="3.0.2"></a>
+## [3.0.2](https://github.com/QingWei-Li/docsify/compare/v3.0.1...v3.0.2) (2017-02-19)
+
+
+### Bug Fixes
+
+* **compiler:** link ([3b127a1](https://github.com/QingWei-Li/docsify/commit/3b127a1))
+* **search:** add lazy input ([bf593a7](https://github.com/QingWei-Li/docsify/commit/bf593a7))
+
+
+
+<a name="3.0.1"></a>
+## [3.0.1](https://github.com/QingWei-Li/docsify/compare/v3.0.0...v3.0.1) (2017-02-19)
+
+
+### Bug Fixes
+
+* **route:** empty alias ([cd99b52](https://github.com/QingWei-Li/docsify/commit/cd99b52))
+
+
+
+<a name="3.0.0"></a>
+# [3.0.0](https://github.com/QingWei-Li/docsify/compare/v2.4.3...v3.0.0) (2017-02-19)
+
+
+### Bug Fixes
+
+* **compiler:** link ([c7e09c3](https://github.com/QingWei-Li/docsify/commit/c7e09c3))
+* **render:** support html file ([7b6a2ac](https://github.com/QingWei-Li/docsify/commit/7b6a2ac))
+* **search:** escape html ([fcb66e8](https://github.com/QingWei-Li/docsify/commit/fcb66e8))
+* **search:** fix default config ([2efd859](https://github.com/QingWei-Li/docsify/commit/2efd859))
+
+
+### Features
+
+* **front-matter:** add front matter[WIP] ([dbb9278](https://github.com/QingWei-Li/docsify/commit/dbb9278))
+* **render:** add auto header ([b7768b1](https://github.com/QingWei-Li/docsify/commit/b7768b1))
+* **search:** Localization for search placeholder, close [#80](https://github.com/QingWei-Li/docsify/issues/80) ([2351c3e](https://github.com/QingWei-Li/docsify/commit/2351c3e))
+* **themes:** add loading info ([86594a3](https://github.com/QingWei-Li/docsify/commit/86594a3))
+
+
+
+<a name="2.4.3"></a>
+## [2.4.3](https://github.com/QingWei-Li/docsify/compare/v2.4.2...v2.4.3) (2017-02-15)
+
+
+
+<a name="2.4.2"></a>
+## [2.4.2](https://github.com/QingWei-Li/docsify/compare/v2.4.1...v2.4.2) (2017-02-14)
+
+
+### Bug Fixes
+
+* **index:** load file path error ([dc536a3](https://github.com/QingWei-Li/docsify/commit/dc536a3))
+
+
+
+<a name="2.4.1"></a>
+## [2.4.1](https://github.com/QingWei-Li/docsify/compare/v2.4.0...v2.4.1) (2017-02-13)
+
+
+### Bug Fixes
+
+* **index:** cover page ([dd0c84b](https://github.com/QingWei-Li/docsify/commit/dd0c84b))
+
+
+
+<a name="2.4.0"></a>
+# [2.4.0](https://github.com/QingWei-Li/docsify/compare/v2.3.0...v2.4.0) (2017-02-13)
+
+
+### Features
+
+* **hook:** add doneEach ([c6f7602](https://github.com/QingWei-Li/docsify/commit/c6f7602))
+
+
+
+<a name="2.3.0"></a>
+# [2.3.0](https://github.com/QingWei-Li/docsify/compare/v2.2.1...v2.3.0) (2017-02-13)
+
+
+### Bug Fixes
+
+* **event:**  has no effect on a FF mobile browser, fixed [#67](https://github.com/QingWei-Li/docsify/issues/67) ([0ff36c2](https://github.com/QingWei-Li/docsify/commit/0ff36c2))
+* **render:** custom marked renderer ([bf559b4](https://github.com/QingWei-Li/docsify/commit/bf559b4))
+* **render:** fix render link ([a866744](https://github.com/QingWei-Li/docsify/commit/a866744))
+* **render:** image url ([6f87529](https://github.com/QingWei-Li/docsify/commit/6f87529))
+* **render:** render link ([38ea660](https://github.com/QingWei-Li/docsify/commit/38ea660))
+* **src:** fix route ([324301a](https://github.com/QingWei-Li/docsify/commit/324301a))
+* **src:** get alias ([784173e](https://github.com/QingWei-Li/docsify/commit/784173e))
+* **src:** get alias ([ce99a04](https://github.com/QingWei-Li/docsify/commit/ce99a04))
+* **themes:** fix navbar style ([fa54b52](https://github.com/QingWei-Li/docsify/commit/fa54b52))
+* **themes:** update navbar style ([4864d1b](https://github.com/QingWei-Li/docsify/commit/4864d1b))
+
+
+### Features
+
+* **hook:** support custom plugin ([9e81a59](https://github.com/QingWei-Li/docsify/commit/9e81a59))
+* **src:** add alias feature ([24412cd](https://github.com/QingWei-Li/docsify/commit/24412cd))
+* **src:** dynamic title and fix sidebar style ([6b30eb6](https://github.com/QingWei-Li/docsify/commit/6b30eb6))
+
+
+
+<a name="2.2.1"></a>
+## [2.2.1](https://github.com/QingWei-Li/docsify/compare/v2.2.0...v2.2.1) (2017-02-11)
+
+
+### Bug Fixes
+
+* **event:** scroll active sidebar ([50f5fc2](https://github.com/QingWei-Li/docsify/commit/50f5fc2))
+* **search:** crash when not content, fixed [#68](https://github.com/QingWei-Li/docsify/issues/68) ([9d3cc89](https://github.com/QingWei-Li/docsify/commit/9d3cc89))
+* **search:** not work in mobile ([3941304](https://github.com/QingWei-Li/docsify/commit/3941304))
+
+
+
+<a name="2.2.0"></a>
+# [2.2.0](https://github.com/QingWei-Li/docsify/compare/v2.1.0...v2.2.0) (2017-02-09)
+
+
+### Features
+
+* **plugins:** add Google Analytics plugin ([#66](https://github.com/QingWei-Li/docsify/issues/66)) ([ac61bb0](https://github.com/QingWei-Li/docsify/commit/ac61bb0))
+
+
+
+<a name="2.1.0"></a>
+# [2.1.0](https://github.com/QingWei-Li/docsify/compare/v2.0.3...v2.1.0) (2017-02-09)
+
+
+### Bug Fixes
+
+* render name ([12e2479](https://github.com/QingWei-Li/docsify/commit/12e2479))
+* **vue.css:** update sidebar style ([fc140ef](https://github.com/QingWei-Li/docsify/commit/fc140ef))
+
+
+### Features
+
+* add search, close [#43](https://github.com/QingWei-Li/docsify/issues/43) ([eb5ff3e](https://github.com/QingWei-Li/docsify/commit/eb5ff3e))
+
+
+
+<a name="2.0.3"></a>
+## [2.0.3](https://github.com/QingWei-Li/docsify/compare/v2.0.2...v2.0.3) (2017-02-07)
+
+
+### Bug Fixes
+
+* css var polyfill ([8cd386a](https://github.com/QingWei-Li/docsify/commit/8cd386a))
+* css var polyfill ([cbaee21](https://github.com/QingWei-Li/docsify/commit/cbaee21))
+* rendering emojis ([8c7e4d7](https://github.com/QingWei-Li/docsify/commit/8c7e4d7))
+
+
+
+<a name="2.0.2"></a>
+## [2.0.2](https://github.com/QingWei-Li/docsify/compare/v2.0.1...v2.0.2) (2017-02-05)
+
+
+### Bug Fixes
+
+* button style in cover page ([4470855](https://github.com/QingWei-Li/docsify/commit/4470855))
+
+
+
+<a name="2.0.1"></a>
+## [2.0.1](https://github.com/QingWei-Li/docsify/compare/v2.0.0...v2.0.1) (2017-02-05)
+
+
+
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/QingWei-Li/docsify/compare/v1.10.5...v2.0.0) (2017-02-05)
+
+
+### Features
+
+* customize the theme color ([5cc9f05](https://github.com/QingWei-Li/docsify/commit/5cc9f05))
+
+
+
+<a name="1.10.5"></a>
+## [1.10.5](https://github.com/QingWei-Li/docsify/compare/v1.10.4...v1.10.5) (2017-01-28)
+
+
+
+<a name="1.10.4"></a>
+## [1.10.4](https://github.com/QingWei-Li/docsify/compare/v1.10.3...v1.10.4) (2017-01-27)
+
+
+
+<a name="1.10.3"></a>
+## [1.10.3](https://github.com/QingWei-Li/docsify/compare/v1.10.2...v1.10.3) (2017-01-27)
+
+
+
+<a name="1.10.2"></a>
+## [1.10.2](https://github.com/QingWei-Li/docsify/compare/v1.10.1...v1.10.2) (2017-01-25)
+
+
+
+<a name="1.10.1"></a>
+## [1.10.1](https://github.com/QingWei-Li/docsify/compare/v1.10.0...v1.10.1) (2017-01-25)
+
+
+
+<a name="1.10.0"></a>
+# [1.10.0](https://github.com/QingWei-Li/docsify/compare/v1.9.0...v1.10.0) (2017-01-25)
+
+
+
+<a name="1.9.0"></a>
+# [1.9.0](https://github.com/QingWei-Li/docsify/compare/v1.8.0...v1.9.0) (2017-01-24)
+
+
+
+<a name="1.8.0"></a>
+# [1.8.0](https://github.com/QingWei-Li/docsify/compare/v1.7.4...v1.8.0) (2017-01-24)
+
+
+
+<a name="1.7.4"></a>
+## [1.7.4](https://github.com/QingWei-Li/docsify/compare/v1.7.3...v1.7.4) (2017-01-13)
+
+
+
+<a name="1.7.3"></a>
+## [1.7.3](https://github.com/QingWei-Li/docsify/compare/v1.7.2...v1.7.3) (2017-01-13)
+
+
+
+<a name="1.7.2"></a>
+## [1.7.2](https://github.com/QingWei-Li/docsify/compare/v1.7.1...v1.7.2) (2017-01-12)
+
+
+
+<a name="1.7.1"></a>
+## [1.7.1](https://github.com/QingWei-Li/docsify/compare/v1.7.0...v1.7.1) (2017-01-12)
+
+
+
+<a name="1.7.0"></a>
+# [1.7.0](https://github.com/QingWei-Li/docsify/compare/v1.6.1...v1.7.0) (2017-01-12)
+
+
+
+<a name="1.6.1"></a>
+## [1.6.1](https://github.com/QingWei-Li/docsify/compare/v1.6.0...v1.6.1) (2017-01-10)
+
+
+
+<a name="1.6.0"></a>
+# [1.6.0](https://github.com/QingWei-Li/docsify/compare/v1.5.2...v1.6.0) (2017-01-10)
+
+
+
+<a name="1.5.2"></a>
+## [1.5.2](https://github.com/QingWei-Li/docsify/compare/v1.5.1...v1.5.2) (2017-01-10)
+
+
+
+<a name="1.5.1"></a>
+## [1.5.1](https://github.com/QingWei-Li/docsify/compare/v1.5.0...v1.5.1) (2017-01-09)
+
+
+
+<a name="1.5.0"></a>
+# [1.5.0](https://github.com/QingWei-Li/docsify/compare/v1.4.3...v1.5.0) (2017-01-04)
+
+
+### Features
+
+* Markdown parser is configurable, [#42](https://github.com/QingWei-Li/docsify/issues/42) ([8b1000a](https://github.com/QingWei-Li/docsify/commit/8b1000a))
+
+
+
+<a name="1.4.3"></a>
+## [1.4.3](https://github.com/QingWei-Li/docsify/compare/v1.4.2...v1.4.3) (2017-01-01)
+
+
+
+<a name="1.4.2"></a>
+## [1.4.2](https://github.com/QingWei-Li/docsify/compare/v1.4.1...v1.4.2) (2016-12-31)
+
+
+
+<a name="1.4.1"></a>
+## [1.4.1](https://github.com/QingWei-Li/docsify/compare/v1.4.0...v1.4.1) (2016-12-31)
+
+
+
+<a name="1.4.0"></a>
+# [1.4.0](https://github.com/QingWei-Li/docsify/compare/v1.3.5...v1.4.0) (2016-12-31)
+
+
+
+<a name="1.3.5"></a>
+## [1.3.5](https://github.com/QingWei-Li/docsify/compare/v1.3.4...v1.3.5) (2016-12-25)
+
+
+
+<a name="1.3.4"></a>
+## [1.3.4](https://github.com/QingWei-Li/docsify/compare/v1.3.3...v1.3.4) (2016-12-25)
+
+
+
+<a name="1.3.3"></a>
+## [1.3.3](https://github.com/QingWei-Li/docsify/compare/v1.3.2...v1.3.3) (2016-12-23)
+
+
+
+<a name="1.3.2"></a>
+## [1.3.2](https://github.com/QingWei-Li/docsify/compare/v1.3.1...v1.3.2) (2016-12-22)
+
+
+
+<a name="1.3.1"></a>
+## [1.3.1](https://github.com/QingWei-Li/docsify/compare/v1.3.0...v1.3.1) (2016-12-22)
+
+
+
+<a name="1.3.0"></a>
+# [1.3.0](https://github.com/QingWei-Li/docsify/compare/v1.2.0...v1.3.0) (2016-12-21)
+
+
+
+<a name="1.2.0"></a>
+# [1.2.0](https://github.com/QingWei-Li/docsify/compare/v1.1.7...v1.2.0) (2016-12-20)
+
+
+
+<a name="1.1.7"></a>
+## [1.1.7](https://github.com/QingWei-Li/docsify/compare/v1.1.6...v1.1.7) (2016-12-19)
+
+
+
+<a name="1.1.6"></a>
+## [1.1.6](https://github.com/QingWei-Li/docsify/compare/v1.1.5...v1.1.6) (2016-12-18)
+
+
+
+<a name="1.1.5"></a>
+## [1.1.5](https://github.com/QingWei-Li/docsify/compare/v1.1.4...v1.1.5) (2016-12-18)
+
+
+
+<a name="1.1.4"></a>
+## [1.1.4](https://github.com/QingWei-Li/docsify/compare/v1.1.3...v1.1.4) (2016-12-17)
+
+
+
+<a name="1.1.3"></a>
+## [1.1.3](https://github.com/QingWei-Li/docsify/compare/v1.1.2...v1.1.3) (2016-12-17)
+
+
+
+<a name="1.1.2"></a>
+## [1.1.2](https://github.com/QingWei-Li/docsify/compare/v1.1.1...v1.1.2) (2016-12-17)
+
+
+
+<a name="1.1.1"></a>
+## [1.1.1](https://github.com/QingWei-Li/docsify/compare/v1.1.0...v1.1.1) (2016-12-17)
+
+
+
+<a name="1.1.0"></a>
+# [1.1.0](https://github.com/QingWei-Li/docsify/compare/v1.0.3...v1.1.0) (2016-12-16)
+
+
+
+<a name="1.0.3"></a>
+## [1.0.3](https://github.com/QingWei-Li/docsify/compare/v1.0.2...v1.0.3) (2016-12-13)
+
+
+
+<a name="1.0.2"></a>
+## [1.0.2](https://github.com/QingWei-Li/docsify/compare/v1.0.1...v1.0.2) (2016-12-13)
+
+
+
+<a name="1.0.1"></a>
+## [1.0.1](https://github.com/QingWei-Li/docsify/compare/v1.0.0...v1.0.1) (2016-12-08)
+
+
+
+<a name="1.0.0"></a>
+# [1.0.0](https://github.com/QingWei-Li/docsify/compare/v0.7.0...v1.0.0) (2016-12-08)
+
+
+
+<a name="0.7.0"></a>
+# [0.7.0](https://github.com/QingWei-Li/docsify/compare/v0.6.1...v0.7.0) (2016-11-30)
+
+
+
+<a name="0.6.1"></a>
+## [0.6.1](https://github.com/QingWei-Li/docsify/compare/v0.6.0...v0.6.1) (2016-11-29)
+
+
+
+<a name="0.6.0"></a>
+# [0.6.0](https://github.com/QingWei-Li/docsify/compare/v0.5.0...v0.6.0) (2016-11-29)
+
+
+
+<a name="0.5.0"></a>
+# [0.5.0](https://github.com/QingWei-Li/docsify/compare/v0.4.2...v0.5.0) (2016-11-28)
+
+
+
+<a name="0.4.2"></a>
+## [0.4.2](https://github.com/QingWei-Li/docsify/compare/v0.4.1...v0.4.2) (2016-11-28)
+
+
+
+<a name="0.4.1"></a>
+## [0.4.1](https://github.com/QingWei-Li/docsify/compare/v0.4.0...v0.4.1) (2016-11-28)
+
+
+
+<a name="0.4.0"></a>
+# [0.4.0](https://github.com/QingWei-Li/docsify/compare/v0.3.1...v0.4.0) (2016-11-27)
+
+
+### Features
+
+* custom sidebar, [#4](https://github.com/QingWei-Li/docsify/issues/4) ([#5](https://github.com/QingWei-Li/docsify/issues/5)) ([37e7984](https://github.com/QingWei-Li/docsify/commit/37e7984))
+
+
+
+<a name="0.3.1"></a>
+## [0.3.1](https://github.com/QingWei-Li/docsify/compare/v0.3.0...v0.3.1) (2016-11-27)
+
+
+
+<a name="0.3.0"></a>
+# [0.3.0](https://github.com/QingWei-Li/docsify/compare/v0.2.1...v0.3.0) (2016-11-27)
+
+
+
+<a name="0.2.1"></a>
+## [0.2.1](https://github.com/QingWei-Li/docsify/compare/v0.2.0...v0.2.1) (2016-11-26)
+
+
+
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/QingWei-Li/docsify/compare/v0.1.0...v0.2.0) (2016-11-26)
+
+
+
+<a name="0.1.0"></a>
+# [0.1.0](https://github.com/QingWei-Li/docsify/compare/v0.0.5...v0.1.0) (2016-11-26)
+
+
+
+<a name="0.0.5"></a>
+## [0.0.5](https://github.com/QingWei-Li/docsify/compare/v0.0.4...v0.0.5) (2016-11-24)
+
+
+
+<a name="0.0.4"></a>
+## [0.0.4](https://github.com/QingWei-Li/docsify/compare/v0.0.3...v0.0.4) (2016-11-22)
+
+
+
+<a name="0.0.3"></a>
+## [0.0.3](https://github.com/QingWei-Li/docsify/compare/v0.0.2...v0.0.3) (2016-11-20)
+
+
+
+<a name="0.0.2"></a>
+## [0.0.2](https://github.com/QingWei-Li/docsify/compare/v0.0.1...v0.0.2) (2016-11-20)
+
+
+
+<a name="0.0.1"></a>
+## 0.0.1 (2016-11-20)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 cinwell.li
+Copyright (c) 2016 - 2017 cinwell.li
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,34 +1,114 @@
-# docsify
-[![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docsify)
-[![npm](https://img.shields.io/npm/v/docsify.svg)](https://www.npmjs.com/package/docsify)
+<p align="center">
+  <a href="https://docsify.js.org">
+    <img alt="docsify" src="./media/docsify.png">
+  </a>
+</p>
+
+<p align="center">
+  A magical documentation site generator.
+</p>
+
+<p align="center">
+  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/QingWei-Li/docsify/master.svg?style=flat-square"></a>
+  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
+  <a href="https://cdnjs.com/libraries/docsify"><img alt="cdnjs" src="https://img.shields.io/cdnjs/v/docsify.svg?style=flat-square"></a>
+  <a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
+</p>
+
+
+<a target='_blank' rel='nofollow' href='https://app.codesponsor.io/link/YdWAqnN2kHQmLtFQhEddaaPT/QingWei-Li/docsify'>  <img alt='Sponsor' width='888' height='68' src='https://app.codesponsor.io/embed/YdWAqnN2kHQmLtFQhEddaaPT/QingWei-Li/docsify.svg' /></a>
 
->🃏 A magical documentation site generator.
 
 ## Links
-- [Documentation](https://qingwei-li.github.io/docsify)
+
+- [Documentation](https://docsify.js.org)
 - [CLI](https://github.com/QingWei-Li/docsify-cli)
+- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/)
 
 ## Features
-- Easy and lightweight
-- Custom themes
-- No build
+
+- No statically built html files
+- Simple and lightweight (~18kB gzipped)
+- Smart full-text search plugin
+- Multiple themes
+- Useful plugin API
+- Compatible with IE10+
+- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
 
 ## Quick start
-Create `404.html` and `README.md` into `/docs`.
 
-404.html
+Create an `index.html`.
 
 ```html
+<!-- index.html -->
+
 <!DOCTYPE html>
 <html>
 <head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
   <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
 </head>
-<body></body>
-<script src="//unpkg.com/docsify"></script>
+<body>
+  <div id="app"></div>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+</body>
 </html>
 ```
 
+## Browser Support
+
+Modern browsers and Internet Explorer 10+.
+
+## Showcase
+
+These projects are using docsify to generate their sites. Pull requests welcome :blush:
+
+| Project | Description |
+|---|---|
+| [Snipaste](https://docs.snipaste.com/) | Snip & Paste |
+| [puck](https://puck.zz173.com/) | A small & magical php framework. |
+| [Samaritan](http://samaritan.stockdb.org) | An Algorithmic Trading Framework for Digital Currency. |
+| [Vudash](http://vudash.github.io/vudash/) | Powerful, Flexible, Open Source dashboards for anything |
+| [Trilogy](http://trilogy.js.org) | No-hassle SQLite with a Promise-based, document store style API. |
+| [Mybatis-Plus](http://mp.baomidou.com/) | An enhanced toolkit of Mybatis to simplify development |
+| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. |
+| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. |
+| [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. |
+| [samlify](https://samlify.js.org) | Node.js SAML2 library |
+| [palettify](https://dobromir-hristov.github.io/palettify/) | A color palette effects assistant |
+| [commitlint](https://marionebl.github.io/commitlint/) | Lint commit messages |
+| [vue-data-tables](https://github.com/njleonzhang/vue-data-tables/) | A simple and customizable data table，based on vue2 and element-ui. |
+| [Noty](http://ned.im/noty/) | A Dependency-free notification library |
+| [xTeko](https://docs.xteko.com/) | Addins framework for Pin 3.0 |
+| [vue2-datatable-component](https://github.com/OneWayTech/vue2-datatable) | The best Datatable for Vue.js 2.x which never sucks |
+
+## Similar projects
+
+| Project | Description |
+|---|---|
+| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
+| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
+
+## Contributing
+
+- Fork it!
+- Create your feature branch: `git checkout -b my-new-feature`
+- Commit your changes: `git commit -am 'Add some feature'`
+- Push to the branch: `git push origin my-new-feature`
+- Submit a pull request
+
+
+## Development
+
+```bash
+npm run bootstrap && npm run dev
+open http://localhost:3000
+```
+
 ## License
+
 MIT
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large)
+

app.js

@@ -0,0 +1,53 @@
+var serveStatic = require('serve-static')
+var http = require('http')
+var fs = require('fs')
+var Renderer = require('./packages/docsify-server-renderer/build.js')
+
+var renderer = new Renderer({
+  template: `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="/themes/vue.css" title="vue">
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+<script src="/lib/docsify.js"></script>
+</body>
+</html>`,
+  config: {
+    name: 'docsify',
+    repo: 'qingwei-li/docsify',
+    basePath: 'https://docsify.js.org/',
+    loadNavbar: true,
+    loadSidebar: true,
+    subMaxLevel: 3,
+    auto2top: true,
+    alias: {
+      '/de-de/changelog': '/changelog',
+      '/zh-cn/changelog': '/changelog',
+      '/changelog':
+        'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+    }
+  },
+  path: './'
+})
+
+http
+  .createServer(function (req, res) {
+    serveStatic('.')(req, res, function () {
+      // TEST SSR
+      // renderer.renderToString(req.url)
+      // .then(html => res.end(html))
+
+      res.writeHead(404, { 'Content-Type': 'text/html' })
+      res.end(fs.readFileSync('dev.html'))
+    })
+  })
+  .listen(3000, '0.0.0.0')
+
+console.log(`\nListening at http://0.0.0.0:3000\n`)

build/build-cover.js

@@ -0,0 +1,14 @@
+var fs = require('fs')
+var read = fs.readFileSync
+var write = fs.writeFileSync
+var version = process.env.VERSION || require('../package.json').version
+
+var file = __dirname + '/../docs/_coverpage.md'
+var cover = read(file, 'utf8').toString()
+
+console.log('Replace version number in cover page...')
+cover = cover.replace(
+  /<small>(\S+)?<\/small>/g,
+  '<small>' + version + '</small>'
+)
+write(file, cover)

build/build-css.js

@@ -0,0 +1,50 @@
+var fs = require('fs')
+var cssnano = require('cssnano').process
+var resolve = require('path').resolve
+var postcss = require('postcss')
+var isProd = process.argv[process.argv.length - 1] !== '--dev'
+
+var processor = postcss([
+  require('postcss-salad')({
+    features: {
+      precss: {
+        properties: {
+          preserve: true
+        }
+      }
+    }
+  })
+])
+
+var saveMin = function (file, content) {
+  fs.writeFileSync(resolve(__dirname, '../lib/themes/', file), content)
+}
+var save = function (file, content) {
+  fs.writeFileSync(resolve(__dirname, '../themes/', file), content)
+}
+var load = function (file) {
+  return fs.readFileSync(resolve(__dirname, '../src/themes/', file)).toString()
+}
+var loadLib = function (file) {
+  return fs.readFileSync(resolve(__dirname, '../themes/', file)).toString()
+}
+
+var list = fs.readdirSync(resolve(__dirname, '../src/themes'))
+
+list.forEach(function (file) {
+  if (!/\.css$/.test(file)) return
+  processor
+    .process(load(file), { from: resolve(__dirname, '../src/themes/', file) })
+    .then(function (result) {
+      save(file, result.css)
+      console.log('salad - ' + file)
+      isProd &&
+        cssnano(loadLib(file)).then(function (result) {
+          saveMin(file, result.css)
+          console.log('cssnao - ' + file)
+        })
+    })
+    .catch(function (err) {
+      console.log(err)
+    })
+})

build/build-ssr.js

@@ -0,0 +1,33 @@
+var rollup = require('rollup')
+var buble = require('rollup-plugin-buble')
+var async = require('rollup-plugin-async')
+var replace = require('rollup-plugin-replace')
+
+rollup
+  .rollup({
+    entry: 'packages/docsify-server-renderer/index.js',
+    plugins: [
+      async(),
+      replace({
+        __VERSION__: process.env.VERSION || require('../package.json').version
+      }),
+      buble({
+        transforms: {
+          generator: false
+        }
+      })
+    ],
+    onwarn: function () {}
+  })
+  .then(function (bundle) {
+    var dest = 'packages/docsify-server-renderer/build.js'
+
+    console.log(dest)
+    bundle.write({
+      format: 'cjs',
+      dest: dest
+    })
+  })
+  .catch(function (err) {
+    console.error(err)
+  })

build/build.js

@@ -2,33 +2,73 @@ var rollup = require('rollup')
 var buble = require('rollup-plugin-buble')
 var commonjs = require('rollup-plugin-commonjs')
 var nodeResolve = require('rollup-plugin-node-resolve')
+var string = require('rollup-plugin-string')
 var uglify = require('rollup-plugin-uglify')
+var replace = require('rollup-plugin-replace')
+var isProd = process.argv[process.argv.length - 1] !== '--dev'
+var version = process.env.VERSION || require('../package.json').version
 
 var build = function (opts) {
   rollup
     .rollup({
       entry: 'src/' + opts.entry,
-      plugins: [buble()].concat(opts.plugins || [])
+      plugins: (opts.plugins || []).concat([
+        string({ include: '**/*.css' }),
+        buble(),
+        commonjs(),
+        nodeResolve(),
+        replace({
+          __VERSION__: version
+        })
+      ])
     })
     .then(function (bundle) {
       var dest = 'lib/' + (opts.output || opts.entry)
 
       console.log(dest)
       bundle.write({
-        format: 'umd',
-        moduleName: opts.moduleName || 'Docsify',
+        format: 'iife',
         dest: dest
       })
     })
+    .catch(function (err) {
+      console.error(err)
+    })
 }
 
 build({
-  entry: 'docsify.js',
-  output: 'docsify.js',
-  plugins: [commonjs(), nodeResolve()]
+  entry: 'core/index.js',
+  output: 'docsify.js'
 })
-build({
-  entry: 'docsify.js',
-  output: 'docsify.min.js',
-  plugins: [commonjs(), nodeResolve(), uglify()]
+
+var plugins = [
+  { name: 'search', entry: 'search/index.js' },
+  { name: 'ga', entry: 'ga.js' },
+  { name: 'emoji', entry: 'emoji.js' },
+  { name: 'external-script', entry: 'external-script.js' },
+  { name: 'front-matter', entry: 'front-matter/index.js' },
+  { name: 'zoom-image', entry: 'zoom-image.js' },
+  { name: 'codesponsor', entry: 'codesponsor.js' }
+]
+
+plugins.forEach(item => {
+  build({
+    entry: 'plugins/' + item.entry,
+    output: 'plugins/' + item.name + '.js'
+  })
 })
+
+if (isProd) {
+  build({
+    entry: 'core/index.js',
+    output: 'docsify.min.js',
+    plugins: [uglify()]
+  })
+  plugins.forEach(item => {
+    build({
+      entry: 'plugins/' + item.entry,
+      output: 'plugins/' + item.name + '.min.js',
+      plugins: [uglify()]
+    })
+  })
+}

build/release.sh

@@ -0,0 +1,50 @@
+set -e
+
+if [[ -z $1 ]]; then
+  echo "Enter new version: "
+  read VERSION
+else
+  VERSION=$1
+fi
+
+read -p "Releasing $VERSION $RELEASE_TAG - are you sure? (y/n) " -n 1 -r
+echo
+if [[ $REPLY =~ ^[Yy]$ ]]; then
+  echo "Releasing $VERSION ..."
+
+  npm run test
+
+  # build
+  VERSION=$VERSION npm run build
+
+  # update packages
+  cd packages/docsify-server-renderer
+  npm version $VERSION
+  if [[ -z $RELEASE_TAG ]]; then
+    npm publish
+  else
+    npm publish --tag $RELEASE_TAG
+  fi
+  cd -
+
+  # commit
+  git add -A
+  git commit -m "[build] $VERSION $RELEASE_TAG"
+  npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
+
+  # changelog
+  node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s
+
+  git add .
+  git commit -m "chore: add changelog $VERSION"
+
+  # publish
+  git tag v$VERSION
+  git push origin refs/tags/v$VERSION
+  git push
+  if [[ -z $RELEASE_TAG ]]; then
+    npm publish
+  else
+    npm publish --tag $RELEASE_TAG
+  fi
+fi

dev.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="/themes/vue.css" title="vue">
+  <link rel="stylesheet" href="/themes/dark.css" title="dark" disabled>
+  <link rel="stylesheet" href="/themes/buble.css" title="buble" disabled>
+  <style>
+    nav.app-nav li ul {
+      min-width: 100px;
+    }
+  </style>
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script>
+  window.$docsify = {
+    alias: {
+      '.*?/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG',
+      '/.*/_navbar.md': '/_navbar.md'
+    },
+    auto2top: true,
+    basePath: '/docs/',
+    executeScript: true,
+    loadNavbar: true,
+    loadSidebar: true,
+    coverpage: true,
+    name: 'docsify',
+    subMaxLevel: 2,
+    mergeNavbar: true,
+    formatUpdated: '{MM}/{DD} {HH}:{mm}',
+    plugins: [
+      function(hook, vm) {
+        hook.beforeEach(function (html) {
+          var url = 'https://github.com/QingWei-Li/docsify/blob/master/' + vm.route.file
+          var editHtml = '[:memo: Edit Document](' + url + ')\n'
+
+          return editHtml
+            + html
+            + '\n----\n'
+            + 'Last modified {docsify-updated} '
+            + editHtml
+        })
+      }
+    ]
+  }
+</script>
+<script src="/lib/docsify.js"></script>
+</html>

docs/404.html

@@ -1,18 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Docsify</title>
-  <meta name="description" content="A magical documentation generator.">
-  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-</head>
-<body>
-  <nav>
-    <a href="/">En</a>
-    <a href="/zh-cn">中文</a>
-  </nav>
-  <div id="app"></div>
-</body>
-<script src="//unpkg.com/docsify" data-repo="qingwei-li/docsify"></script>
-</html>

docs/CNAME

@@ -0,0 +1 @@
+docsify.js.org

docs/README.md

@@ -1,98 +1,28 @@
-# docsify
+## docsify
 
 > A magical documentation site generator.
 
+## What is it
+
+docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](deploy.md).
+
+See the [Quick start](quickstart.md) for more details.
+
 ## Features
-- Easy and lightweight
-- Custom themes
-- No build
 
-## Quick Start
+* No statically built html files
+* Simple and lightweight (~18kB gzipped)
+* Smart full-text search plugin
+* Multiple themes
+* Useful plugin API
+* Emoji support
+* Compatible with IE10+
+- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
 
-### Create a project
-First create a project, then create a `docs` folder
-```shell
-mkdir my-project && cd my-project
-mkdir docs && cd docs
-```
+## Examples
 
-### Create entry file
-Create a `404.html` file
+Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use.
 
-```html
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-</body>
-<script src="//unpkg.com/docsify"></script>
-</html>
-```
+## Donate
 
-Create `README.md` as the main page
-
-```
-# Title
-
-## balabala
-```
-
-### Deploy!
-Push and open the **GitHub Pages** feature
-![image](https://cloud.githubusercontent.com/assets/7565692/20639058/e65e6d22-b3f3-11e6-9b8b-6309c89826f2.png)
-
-## CLI
-
-Easy to setup and preivew a docs.
-
-### Install
-```shell
-npm i docsify-cli -g
-```
-
-### Setup
-
-Setup a boilerplate docs
-```shell
-docsify init docs
-```
-
-### Preview
-Preview and serve your docs using
-```shell
-docsify serve docs
-```
-
-Read more [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
-
-## Themes
-Currently available `vue.css` and `buble.css`
-```html
-<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
-```
-
-## More
-
-### Multiple pages
-If you need other pages, directly create the markdown file, such as `guide.md` is `/guide`.
-
-### Navbar
-Code in `404.html`
-
-```html
-<nav>
-  <a href="/">En</a>
-  <a href="/zh-cn">中文</a>
-</nav>
-```
-
-### GitHub Corner
-Modify your `404.html`
-```html
-<script src="//unpkg.com/docsify" data-repo="your/repo"></script>
-```
+Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:

docs/_coverpage.md

@@ -0,0 +1,13 @@
+![logo](_media/icon.svg)
+
+# docsify <small>4.3.9</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~18kB gzipped)
+- No statically built html files
+- Multiple themes
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#docsify)

docs/_media/icon.svg

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="122px" height="94px" viewBox="0 0 122 94" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 41.2 (35397) - http://www.bohemiancoding.com/sketch -->
+    <title>icon</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <path d="M144.453286,104 C177.038086,104 203.453286,77.5848002 203.453286,45 C203.453286,12.4151998 177.038086,-14 144.453286,-14 C111.868486,-14 114.603207,13.6754846 114.603207,46.2602848 C114.603207,78.845085 111.868486,104 144.453286,104 Z" id="path-1"></path>
+        <filter x="-50%" y="-50%" width="200%" height="200%" filterUnits="objectBoundingBox" id="filter-2">
+            <feOffset dx="7" dy="-10" in="SourceAlpha" result="shadowOffsetInner1"></feOffset>
+            <feComposite in="shadowOffsetInner1" in2="SourceAlpha" operator="arithmetic" k2="-1" k3="1" result="shadowInnerInner1"></feComposite>
+            <feColorMatrix values="0 0 0 0 0   0 0 0 0 0   0 0 0 0 0  0 0 0 0.1 0" type="matrix" in="shadowInnerInner1"></feColorMatrix>
+        </filter>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="icon" transform="translate(-98.000000, 2.000000)">
+            <g id="body" transform="translate(159.000000, 45.000000) rotate(-90.000000) translate(-159.000000, -45.000000) ">
+                <use fill="#2ECE53" fill-rule="evenodd" xlink:href="#path-1"></use>
+                <use fill="black" fill-opacity="1" filter="url(#filter-2)" xlink:href="#path-1"></use>
+                <use stroke="#0E1320" stroke-width="4" xlink:href="#path-1"></use>
+            </g>
+            <circle id="left-eye" fill="#000000" cx="139" cy="38" r="7"></circle>
+            <circle id="right-eye" fill="#000000" cx="183" cy="38" r="7"></circle>
+            <g id="light" transform="translate(112.000000, 10.000000)" fill="#FFFFFF">
+                <circle cx="2" cy="28" r="2"></circle>
+                <path d="M12.2551528,-1.65016666 C12.1154537,-2.17684986 12.4455583,-2.60381096 13.011574,-2.60381096 L14.9928363,-2.60381096 C15.5502953,-2.60381096 16.1214654,-2.16566487 16.2594657,-1.64268776 C16.2594657,-1.64268776 17.4280152,2.48668594 17.9030739,6.45786647 C18.3781327,10.429047 18.3171359,10.4652901 18.3171359,12.1782569 C18.3171359,16.9413523 16.2076398,26.4389164 16.2076398,26.4389164 C16.0941814,26.9676035 15.558852,27.396189 14.9928363,27.396189 L13.011574,27.396189 C12.454115,27.396189 12.1166642,26.9691757 12.2568366,26.4301177 C12.2568366,26.4301177 13.4260575,22.2288768 13.9640759,17.9859148 C14.5020943,13.7429529 14.309594,15.2982629 14.5626609,12.3723978 C14.9355337,8.06138047 12.2551528,-1.65016666 12.2551528,-1.65016666 Z" id="light-line" transform="translate(15.271433, 12.396189) scale(-1, 1) rotate(-48.000000) translate(-15.271433, -12.396189) "></path>
+            </g>
+            <path d="M159.5,78.3050108 C169.164983,78.3050108 177,70.4699939 177,60.8050108 C177,51.1400277 169.688728,56.4616841 160.023745,56.4616841 C150.358762,56.4616841 142,51.1400277 142,60.8050108 C142,70.4699939 149.835017,78.3050108 159.5,78.3050108 Z" id="mouth" fill="#000000"></path>
+        </g>
+    </g>
+</svg>

docs/_navbar.md

@@ -0,0 +1,4 @@
+- Translations
+  - [:cn: 中文](/zh-cn/)
+  - [:de: Deutsch](/de-de/)
+  - [:uk: English](/)

docs/_sidebar.md

@@ -0,0 +1,23 @@
+- Getting started
+  - [Quick start](quickstart.md)
+  - [Writing more pages](more-pages.md)
+  - [Custom navbar](custom-navbar.md)
+  - [Cover page](cover.md)
+
+- Customization
+  - [Configuration](configuration.md)
+  - [Themes](themes.md)
+  - [List of Plugins](plugins.md)
+  - [Write a Plugin](write-a-plugin.md)
+  - [Markdown configuration](markdown.md)
+  - [Language highlighting](language-highlight.md)
+
+- Guide
+  - [Deploy](deploy.md)
+  - [Helpers](helpers.md)
+  - [Vue compatibility](vue.md)
+  - [CDN](cdn.md)
+  - [Offline Mode(PWA)](pwa.md)
+  - [Server-client renderer(SSR)](ssr.md)
+
+- [Changelog](changelog.md)

docs/cdn.md

@@ -0,0 +1,50 @@
+# CDN
+
+Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon as it is published to npm. You can also browse the source of the npm package at [unpkg.com/docsify/](//unpkg.com/docsify/).
+
+## Latest version
+
+```html
+<!-- load css -->
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+
+<!-- load script -->
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+```
+
+Alternatively, use [compressed files](#compressed-files).
+
+## Specific version
+
+```html
+<!-- load css -->
+<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/themes/vue.css">
+
+<!-- load script -->
+<script src="//unpkg.com/docsify@2.0.0/lib/docsify.js"></script>
+```
+
+## Compressed file
+
+```html
+<!-- load css -->
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+
+<!-- load script -->
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```html
+<!-- load css -->
+<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/lib/themes/vue.css">
+
+<!-- load script -->
+<script src="//unpkg.com/docsify@2.0.0/lib/docsify.min.js"></script>
+```
+
+## Other CDN
+
+- http://www.bootcdn.cn/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
+- https://cdnjs.com/libraries/docsify
+

docs/configuration.md

@@ -0,0 +1,382 @@
+# Configuration
+
+**docsify** supports two different ways of configuration. You can configure the `window.$docsify` or write configuration on the script tag via `data-*` attributes.
+
+```html
+<!-- by $docsify -->
+<script>
+  window.$docsify = {
+    repo: 'QingWei-Li/docsify',
+    maxLevel: 3,
+    coverpage: true
+  }
+</script>
+
+<!-- or data-* -->
+<script
+  src="//unpkg.com/docsify"
+  data-repo="QingWei-Li/docsify"
+  data-max-level="3"
+  data-coverpage>
+</script>
+```
+
+Both ways are compatible. However, the first way is recommended. It is clear and can be configured in a separate file.
+
+!> In `window.$docsfiy`, the options should be written by camelCase.
+
+## el
+
+- Type: `String`
+- Default: `#app`
+
+The DOM element to be mounted on initialization. It can be a CSS selector string or an actual HTMLElement.
+
+```js
+window.$docsify = {
+  el: '#app'
+}
+```
+
+## repo
+
+- Type: `String`
+- Default: `null`
+
+Configure the repository url or a string of `username/repo` can add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
+
+```js
+window.$docsify = {
+  repo: 'QingWei-Li/docsify',
+  // or
+  repo: 'https://github.com/QingWei-Li/docsify/'
+}
+```
+
+## max-level
+
+- Type: `Number`
+- Default: `6`
+
+Maximum Table of content level.
+
+```js
+window.$docsify = {
+  maxLevel: 4
+}
+```
+
+## load-navbar
+
+- Type: `Boolean|String`
+- Default: `false`
+
+Loads navbar from the Markdown file `_navbar.md` if **true**, or else from the path specified.
+
+```js
+window.$docsify = {
+  // load from _navbar.md
+  loadNavbar: true,
+
+  // load from nav.md
+  loadNavbar: 'nav.md'
+}
+```
+
+## load-sidebar
+
+- Type: `Boolean|String`
+- Default: `false`
+
+Loads sidebar from the Markdown file `_sidebar.md` if **true**, or else from the path specified.
+
+```js
+window.$docsify = {
+  // load from _sidebar.md
+  loadSidebar: true,
+
+  // load from summary.md
+  loadSidebar: 'summary.md'
+}
+```
+
+## sub-max-level
+
+- Type: `Number`
+- Default: `0`
+
+Add table of contents (TOC) in custom sidebar.
+
+```js
+window.$docsify = {
+  subMaxLevel: 2
+}
+```
+
+## auto2top
+
+- Type: `Boolean`
+- Default: `false`
+
+Scrolls to the top of the screen when the route is changed.
+
+```js
+window.$docsify = {
+  auto2top: true
+}
+```
+
+## homepage
+
+- Type: `String`
+- Default: `README.md`
+
+`README.md` in your docs folder will be treated as homepage for your website, but sometimes you may need to serve another file as your homepage.
+
+```js
+window.$docsify = {
+  // Change to /home.md
+  homepage: 'home.md',
+
+  // Or use the readme in your repo
+  homepage: 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
+}
+```
+
+## base-path
+
+- Type: `String`
+
+Base path of the website. You can set it to another directory or another domain name.
+
+```js
+window.$docsify = {
+  basePath: '/path/',
+
+  // Load the files from another site
+  basePath: 'https://docsify.js.org/',
+
+  // Even can load files from other repo
+  basePath: 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
+}
+```
+
+## coverpage
+
+- Type: `Boolean|String`
+- Default: `false`
+
+Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`.
+
+```js
+window.$docsify = {
+  coverpage: true,
+
+  // Custom file name
+  coverpage: 'cover.md'
+}
+```
+
+## name
+
+- Type: `String`
+
+Website name as it appears in the sidebar.
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+## name-link
+
+- Type: `String`
+- Default: `window.location.pathname`
+
+The name of the link.
+
+```js
+window.$docsify = {
+  nameLink: '/',
+
+  // For each route
+  nameLink: {
+    '/zh-cn/': '/zh-cn/',
+    '/': '/'
+  }
+}
+```
+
+## markdown
+
+- Type: `Function`
+
+See [Markdown configuration](markdown.md).
+
+```js
+window.$docsify = {
+  // object
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  },
+
+  // function
+  markdown: function (marked, renderer) {
+    // ...
+    return marked
+  }
+}
+```
+
+## theme-color
+
+- Type: `String`
+
+Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in old browser.
+
+```js
+window.$docsify = {
+  themeColor: '#3F51B5'
+}
+```
+
+## alias
+
+- Type: `Object`
+
+Set the route alias. You can freely manage routing rules. Supports RegExp.
+
+```js
+window.$docsify = {
+  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
+    '/zh-cn/changelog': '/changelog',
+    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+  }
+}
+```
+
+## auto-header
+
+- type: `Boolean`
+
+If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to html. Compare [#78](https://github.com/QingWei-Li/docsify/issues/78).
+
+```js
+window.$docsify = {
+  loadSidebar: true,
+  autoHeader: true
+}
+```
+
+## execute-script
+
+- type: `Boolean`
+
+Execute the script on the page. Only parse the first script tag([demo](themes)).  If Vue is present, it is turned on by default.
+
+```js
+window.$docsify = {
+  executeScript: true
+}
+```
+
+```markdown
+## This is test
+
+<script>
+  console.log(2333)
+</script>
+```
+
+Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins.md?id=external-script) plugin.
+
+## no-emoji
+
+- type: `Boolean`
+
+Disabled emoji parse.
+
+```js
+window.$docsify = {
+  noEmoji: true
+}
+```
+
+## merge-navbar
+
+- type: `Boolean`
+
+Navbar will be merged with the sidebar on smaller screens.
+
+```js
+window.$docsify = {
+  mergeNavbar: true
+}
+```
+
+## format-updated
+
+- type: `String|Function`
+
+We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`.
+See https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+- type: `String`
+- default: `_self`
+
+Target to open external links. Default `'_blank'` (new window/tab)
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```
+
+## router-mode
+
+- type: `String`
+- default: `history`
+
+```js
+window.$docsify = {
+  routerMode: 'history' // default: 'hash'
+}
+```
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```
+

docs/cover.md

@@ -0,0 +1,56 @@
+# Cover
+
+Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).
+
+## Basic usage
+
+Set `coverpage` to **true**, and create a `_coverpage.md`:
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    coverpage: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```markdown
+<!-- _coverpage.md -->
+
+![logo](_media/icon.svg)
+
+# docsify <small>3.5</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~18kB gzipped)
+- No statically built html files
+- Multiple themes
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#docsify)
+```
+
+!> A document site can have only one coverpage!
+
+## Custom background
+
+The background color is generated randomly by default. You can customize the background color or a background image:
+
+```markdown
+<!-- _coverpage.md -->
+
+# docsify <small>3.5</small>
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+
+<!-- background image -->
+![](_media/bg.png)
+
+<!-- background color -->
+![color](#f0f0f0)
+```

docs/custom-navbar.md

@@ -0,0 +1,95 @@
+# Custom navbar
+
+## HTML
+
+If you need custom navigation, you can create a HTML-based navigation bar.
+
+!> Note that documentation links begin with `#/`.
+
+```html
+<!-- index.html -->
+
+<body>
+  <nav>
+    <a href="#/">EN</a>
+    <a href="#/zh-cn/">中文</a>
+  </nav>
+  <div id="app"></div>
+</body>
+```
+
+## Markdown
+
+Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [load-navbar configuration](configuration.md#load-navbar).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadNavbar: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```markdown
+<!-- _navbar.md -->
+
+- [En](/)
+- [chinese](/zh-cn/)
+```
+
+!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
+
+`_navbar.md` is loaded from each level directory. If the current directory doesn't have `_navbar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`,  the `_navbar.md` will be loaded from `/guide/_navbar.md`.
+
+## Nesting
+
+You can create sub-lists by indenting items that are under a certain parent.
+
+```markdown
+<!-- _navbar.md -->
+
+- Getting started
+  - [Quick start](quickstart.md)
+  - [Writing more pages](more-pages.md)
+  - [Custom navbar](custom-navbar.md)
+  - [Cover page](cover.md)
+
+- Configuration
+  - [Configuration](configuration.md)
+  - [Themes](themes.md)
+  - [Using plugins](plugins.md)
+  - [Markdown configuration](markdown.md)
+  - [Language highlight](language-highlight.md)
+```
+
+renders as
+
+![Nesting navbar](_images/nested-navbar.png "Nesting navbar")
+
+## Combining custom navbars with the emoji plugin
+
+If you use the [emoji plugin](plugins#emoji):
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    // ...
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+```
+
+you could, for example, use flag emojis in your custom navbar Markdown file:
+
+```markdown
+<!-- _navbar.md -->
+
+- [:us:, :uk:](/)
+- [:cn:](/zh-cn/)
+```

docs/de-de/README.md

@@ -0,0 +1,28 @@
+## docsify
+
+> Ein magischer Generator für Dokumentationen.
+
+## Was ist das
+
+**docsify** generiert deine Dokumentationswebseite zeitgleich (mit der Darstellung). Im Gegensatz zu GitBook, werden keine statischen HTML Seiten generiert. Stattdessen, werden im Hintergrund Markdown Dateien geladen und umgewandelt, und als Webseite dargestellt. Alles, was du brauchst, ist eine Datei namens `index.html`, um sie über [GitHub Pages zu veröffentlichen](de-de/deploy.md).
+
+Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen.
+
+## Features
+
+* keine generierten, statischen HTML Dateien
+* einfach und klein (~18kB gzipped)
+* smarte Erweiterung mit Volltextsuche
+* mehrere Themes
+* praktische API für Erweiterungen
+* Unterstützung für Emoji
+* Kompatibel mit IE10+
+- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
+
+## Beispiele
+
+Vergleiche die Liste namens [Showcase](https://github.com/QingWei-Li/docsify/#showcase) mit Beispielen, wie **docsify** verwendet wird.
+
+## Spenden
+
+Bitte ziehe eine Spende in Erwägung, sollte **docsify** dir hilfreich oder meine Arbeit dir wertvoll erscheinen. Ich freue mich, wenn du mir [eine Tasse Kaffee kaufst](https://github.com/QingWei-Li/donate). :heart:

docs/de-de/_sidebar.md

@@ -0,0 +1,23 @@
+- Loslegen
+  - [Schnellstart](de-de/quickstart.md)
+  - [Schreiben weiterer Seiten](de-de/more-pages.md)
+  - [Navigationsleiste anpassen](de-de/custom-navbar.md)
+  - [Titelseite](de-de/cover.md)
+
+- Anpassen
+  - [Einstellungen](de-de/configuration.md)
+  - [Themen](de-de/themes.md)
+  - [Liste der Erweiterungen](de-de/plugins.md)
+  - [Schreiben eigener Erweiterungen](de-de/write-a-plugin.md)
+  - [Markdown-Einstellungen](de-de/markdown.md)
+  - [Hervorheben von Sprachen](de-de/language-highlight.md)
+
+- Guide
+  - [Inbetriebnahme](de-de/deploy.md)
+  - [Helfer](de-de/helpers.md)
+  - [Vue Kompatibilität](de-de/vue.md)
+  - [CDN](de-de/cdn.md)
+  - [Offline Modus (PWA)](de-de/pwa.md)
+  - [Server-client renderer (SSR)](de-de/ssr.md)
+
+- [Changelog](de-de/changelog.md)

docs/de-de/cdn.md

@@ -0,0 +1,49 @@
+# CDN
+
+Empfohlen: [unpkg](//unpkg.com), welches jeweils die aktuelle Version liefert, wie sie über npm veröffentlicht wurde. Du kannst auch den Quellcode des npm Packets über [unpkg.com/docsify/](//unpkg.com/docsify/) anschauen.
+
+## Aktuelle Version
+
+```html
+<!-- lade CSS -->
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+
+<!-- lade Script -->
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+```
+
+Alternativ kannst du auch die [komprimierten Dateien](#komprimierte-dateien) verwenden.
+
+## Spezielle Version
+
+```html
+<!-- lade CSS -->
+<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/themes/vue.css">
+
+<!-- lade Script -->
+<script src="//unpkg.com/docsify@2.0.0/lib/docsify.js"></script>
+```
+
+## Komprimierte Dateien
+
+```html
+<!-- lade CSS -->
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+
+<!-- lade Script -->
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```html
+<!-- lade CSS -->
+<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/lib/themes/vue.css">
+
+<!-- lade Script -->
+<script src="//unpkg.com/docsify@2.0.0/lib/docsify.min.js"></script>
+```
+
+## Andere CDN
+
+- http://www.bootcdn.cn/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
+- https://cdnjs.com/libraries/docsify

docs/de-de/configuration.md

@@ -0,0 +1,361 @@
+# Einstellungen
+
+**docsify** unterstützt zwei verschiedene Arten, um die Einstellungen anzupassen. Du kannst das `window.$docsify` anpassen, oder die Einstellungen über das script tag im `data-*` Attribut vornehmen.
+
+```html
+<!-- über $docsify -->
+<script>
+  window.$docsify = {
+    repo: 'QingWei-Li/docsify',
+    maxLevel: 3,
+    coverpage: true
+  }
+</script>
+
+<!-- oder data-* -->
+<script
+  src="//unpkg.com/docsify"
+  data-repo="QingWei-Li/docsify"
+  data-max-level="3"
+  data-coverpage>
+</script>
+```
+
+Beide Arten sind miteinander kompatibel, wobei die erste jedoch empfohlen wird. Sie ist deutlicher und kann in einer separaten Datei geführt werden.
+
+!> Innerhalb des `window.$docsfiy` sollten die Optionen mit camelCase geschrieben werden.
+
+## el
+
+- Typ: `String`
+- Standard: `#app`
+
+Das DOM Element kann bei der Initialisierung gesetzt werden. Es kann ein CSS selector string oder ein richtiges HTMLElement sein.
+
+```js
+window.$docsify = {
+  el: '#app'
+}
+```
+
+## repo
+
+- Typ: `String`
+- Standard: `null`
+
+Verwende die repository URL oder eine Zeichenfolge aus `Benutzername/repo`, um das [GitHub Corner](http://tholman.com/github-corners/) widget in die obere rechte Ecke der Seite zu implementieren.
+
+```js
+window.$docsify = {
+  repo: 'QingWei-Li/docsify',
+  // oder
+  repo: 'https://github.com/QingWei-Li/docsify/'
+}
+```
+
+## max-level
+
+- Typ: `Number`
+- Standard: `6`
+
+Maximale Anzahl der Inhaltsübersichtebenen.
+
+```js
+window.$docsify = {
+  maxLevel: 4
+}
+```
+
+## load-navbar
+
+- Typ: `Boolean|String`
+- Standard: `false`
+
+Lädt die Navigationsleiste von der Markdown Datei `_navbar.md` falls **true**, oder vom gewählten Pfad.
+
+```js
+window.$docsify = {
+  // lade von _navbar.md
+  loadNavbar: true,
+
+  // lade von nav.md
+  loadNavbar: 'nav.md'
+}
+```
+
+## load-sidebar
+
+- Typ: `Boolean|String`
+- Standard: `false`
+
+Lädt das seitliche Inhaltsverzeichnis von der Markdown Datei `_sidebar.md` falls **true**, oder vom gewählten Pfad.
+
+```js
+window.$docsify = {
+  // lade von _sidebar.md
+  loadSidebar: true,
+
+  // lade von summary.md
+  loadSidebar: 'summary.md'
+}
+```
+
+## sub-max-level
+
+- Typ: `Number`
+- Standard: `0`
+
+Wähle die maximale Anzahl der Unterpunkte pro Datei in der Inhaltsübersicht.
+
+```js
+window.$docsify = {
+  subMaxLevel: 2
+}
+```
+
+## auto2top
+
+- Typ: `Boolean`
+- Standard: `false`
+
+Scrolle zum Anfang der Seite, wenn die Route gewechselt wird.
+
+```js
+window.$docsify = {
+  auto2top: true
+}
+```
+
+## homepage
+
+- Typ: `String`
+- Standard: `README.md`
+
+`README.md` in deinem Ordner für die Dokumentation wird als Startseite für deine Webseite gesetzt, aber manchmal musst du das vielleicht ändern.
+
+```js
+window.$docsify = {
+  // Wähle /home.md
+  homepage: 'home.md',
+
+  // Oder verwende das README in deinem repo
+  homepage: 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
+}
+```
+
+## base-path
+
+- Typ: `String`
+
+Der Basispfad der Webseite. Du kannst einen anderen Ordner wählen, oder eine andere Domain.
+
+```js
+window.$docsify = {
+  basePath: '/path/',
+
+  // Lade die Dateien von einer anderen Domain
+  basePath: 'https://docsify.js.org/',
+
+  // Oder lade Dateien von einem anderen repo
+  basePath: 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
+}
+```
+
+## coverpage
+
+- Typ: `Boolean|String`
+- Standard: `false`
+
+Aktiviere das [Titelseitenfeature](de-de/cover.md). Falls `true`, wird sie von `_coverpage.md` geladen.
+
+```js
+window.$docsify = {
+  coverpage: true,
+
+  // Anderer Dateiname
+  coverpage: 'cover.md'
+}
+```
+
+## name
+
+- Typ: `String`
+
+Webseitenname, wie er in der Inhaltsübersicht in der Seitenleiste angezeigt wird.
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+## name-link
+
+- Typ: `String`
+- Standard: `window.location.pathname`
+
+Der Name der Links.
+
+```js
+window.$docsify = {
+  nameLink: '/',
+
+  // Für jede Route
+  nameLink: {
+    '/zh-cn/': '/zh-cn/',
+    '/': '/'
+  }
+}
+```
+
+## markdown
+
+- Typ: `Function`
+
+Siehe [Markdown Konfiguration](de-de/markdown.md).
+
+```js
+window.$docsify = {
+  // Objekt
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  },
+
+  // Funktion
+  markdown: function (marked, renderer) {
+    // ...
+    return marked
+  }
+}
+```
+
+## theme-color
+
+- Typ: `String`
+
+Passe die Farbe der Themen an. Verwende [CSS3 Variablen](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) und polyfill in älteren Browsern.
+
+```js
+window.$docsify = {
+  themeColor: '#3F51B5'
+}
+```
+
+## alias
+
+- Typ: `Object`
+
+Verwende alternative Routen. Du kannst sie ungehindert anpassen. Supports RegExp.
+
+```js
+window.$docsify = {
+  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
+    '/zh-cn/changelog': '/changelog',
+    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+  }
+}
+```
+
+## auto-header
+
+- Typ: `Boolean`
+
+Sollten `loadSidebar` und `autoHeader` beide aktiviert sein, setze einen Header vor die Seite in jedem Link in `_sidebar.md`, bevor sie in HTML umgewandelt wird. Vergleiche [#78](https://github.com/QingWei-Li/docsify/issues/78).
+
+```js
+window.$docsify = {
+  loadSidebar: true,
+  autoHeader: true
+}
+```
+
+## execute-script
+
+- Typ: `Boolean`
+
+Führe das Skript auf der Seite aus. Analysiere nur das erste script tag ([demo](de-de/themes.md)).  Sollte Vue verwendet sein, wird es in der Standardeinstellung ausgeführt.
+
+```js
+window.$docsify = {
+  executeScript: true
+}
+```
+
+```markdown
+## Dies ist ein Test
+
+<script>
+  console.log(2333)
+</script>
+```
+
+?> Nehme zur Kenntnis, dass, solltest du ein externes Skript ausführen, z.B. ein eingebettete jsfiddle demo, du sicher gehen solltest, das [external-script](de-de/plugins.md?id=external-script) plugin zu verwenden.
+
+## no-emoji
+
+Verhindere die Umwandlung in Emojis:
+
+```js
+window.$docsify = {
+  noEmoji: true
+}
+```
+
+## merge-navbar
+
+Navbar will be merged with the sidebar on smaller screens.
+
+```js
+window.$docsify = {
+  mergeNavbar: true
+}
+```
+
+## format-updated
+We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`.
+See https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+Currently it defaults to _blank, would be nice if configurable:
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```
+
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```

docs/de-de/cover.md

@@ -0,0 +1,56 @@
+# Titelseite
+
+Aktiviere die Unterstützung für Titelseiten, indem du `coverpage` auf **true** einstellst, vergleiche [coverpage Einstellungen](configuration.md#coverpage).
+
+## Einfache Verwendung
+
+Setze `coverpage` auf **true**, und erstelle `_coverpage.md`:
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    coverpage: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```markdown
+<!-- _coverpage.md -->
+
+![logo](_media/icon.svg)
+
+# docsify <small>3.5</small>
+
+> Ein magischer Generator für Dokumentationsseiten.
+
+- Einfach und wenig Speicherbedarf (~18kB gzipped)
+- Keine statischen HTML Dateien
+- Mehrere Themes
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Schnellstart](#docsify)
+```
+
+!> Die Dokumentationsseiten können nur eine Titelseite haben!
+
+## Eigener Hintergrund
+
+Die Hintergrundfarbe wird in der Standardeinstellung zufällig generiert. Du kannst sie anpassen, oder auch ein Hintergrundbild verwenden:
+
+```markdown
+<!-- _coverpage.md -->
+
+# docsify <small>3.5</small>
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Schnellstart](#quick-start)
+
+<!-- Hintegrundbild -->
+![](_media/bg.png)
+
+<!-- Hintegrundfarbe -->
+![color](#f0f0f0)
+```

docs/de-de/custom-navbar.md

@@ -0,0 +1,95 @@
+# Navigationsleiste anpassen
+
+## HTML
+
+Solltest du eine Navigationsleiste benötigen, so kannst du eine HTML-basierte erstellen.
+
+!> Die Links der Dokumentation fangen alle mit `#/` an.
+
+```html
+<!-- index.html -->
+
+<body>
+  <nav>
+    <a href="#/">EN</a>
+    <a href="#/de-de/">DE</a>
+  </nav>
+  <div id="app"></div>
+</body>
+```
+
+## Markdown
+
+Oder du kannst deine Navigationsleiste mit einer Datei basierend auf Markdown erstellen, indem du `loadNavbar` auf **true** setzt und eine Datei namens `_navbar.md` erstellst, vergleiche [load-navbar Einstellungen](configuration.md#load-navbar).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadNavbar: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+```markdown
+<!-- _navbar.md -->
+
+- [En](/)
+- [Deutsch](/de-de/)
+```
+
+!> Solltest du Github Pages verwenden, musst du zusätzlich eine Datei namens `.nojekyll` in `./docs` erstellen, um zu verhindern, dass Github Dateien ignoriert, die mit einem Unterstrich anfangen.
+
+`_navbar.md` wird in jedem Verzeichnislevel geladen. Sollte das aktuelle Verzeichnis keine Datei namens `_navbar.md` haben, so sucht **docsify** in den übergeordneten Ordnern. Wenn du z.B. im Moment im Verzeichnis `/guide/quick-start` bist,  so wird `_navbar.md` von der Datei `/guide/_navbar.md` geladen.
+
+## Aufbauen von Strukturen
+
+Du kannst untergeordnete Listen erstellen, indem du untergeordnete Punkte einem übergeordneten Punkt gegenüber einrückst.
+
+```markdown
+<!-- _navbar.md -->
+
+- Getting started
+  - [Quick start](de-de/quickstart.md)
+  - [Writing more pages](de-de/more-pages.md)
+  - [Custom navbar](de-de/custom-navbar.md)
+  - [Cover page](de-de/cover.md)
+
+- Configuration
+  - [Configuration](de-de/configuration.md)
+  - [Themes](de-de/themes.md)
+  - [Using plugins](de-de/plugins.md)
+  - [Markdown configuration](de-de/markdown.md)
+  - [Language highlight](de-de/language-highlight.md)
+```
+
+wird also wie folgt aussehen
+
+![Nesting navbar](_images/nested-navbar.png "Nesting navbar")
+
+## Angepasste Navigationsleisten in Verbindung mit dem emoji Erweiterung
+
+Solltest du die [emoji Erweiterung](plugins.md#emoji) verwenden:
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    // ...
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+```
+
+so kannst du z.B. auch die Flaggenemojis in der Markdown Datei für deine angepasste Navigationsleiste verwenden:
+
+```markdown
+<!-- _navbar.md -->
+
+- [:us:, :uk:](/)
+- [:de:](/de-de/)
+```

docs/de-de/deploy.md

@@ -0,0 +1,57 @@
+# Inbetriebnahme
+
+Ähnlich wie bei [GitBook](https://www.gitbook.com), kannst du deine Dateien über GitHub Pages oder VPS erstellen.
+
+## GitHub Pages
+
+Du kannst folgende drei Orte verwenden, um die Dokumentation für dein Github repository zu verwalten:
+
+* `docs/` Ordner
+* master branch
+* gh-pages branch
+
+Es wird empfohlen, deine Dateien im `./docs` Unterordner im `master` branch deines repository zu speichern. Wechsle dann zu den Einstellungen deines repository und wähle `master branch /docs folder` als deine Github Pages Quelle.
+
+![github pages](_images/deploy-github-pages.png)
+
+!> Du kannst die Dateien auch im Hauptverzeichnis speichern und dann `master branch` in den Einstellungen auswählen.
+
+
+## GitLab Pages
+
+If you are deploying your master branch, include `.gitlab-ci.yml` with the following script:
+
+?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
+
+``` YAML
+pages:
+  stage: deploy
+  script:
+  - mkdir .public
+  - cp -r * .public
+  - mv .public public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master
+```
+
+!> You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
+
+
+## VPS
+
+Verwende folgende nginx config.
+
+```nginx
+server {
+  listen 80;
+  server_name  your.domain.com;
+
+  location / {
+    alias /path/to/dir/of/docs;
+    index index.html;
+  }
+}
+```

docs/de-de/helpers.md

@@ -0,0 +1,58 @@
+# Dokumentationshelfer
+
+docsify erweitert die Markdownsyntax, um deine Dokumente besser lesbar zu machen.
+
+## Wichtiger Inhalt
+
+Wichtiger Inhalt wie:
+
+```markdown
+!> **Zeit** ist Geld, mein Freund!
+```
+
+wird wie folgt gerendert:
+
+!> **Zeit** ist Geld, mein Freund!
+
+## Generelle Tipps
+
+Generelle Tipps wie:
+
+```markdown
+?> *TODO* unit test
+```
+
+wird wie folgt gerendert:
+
+?> *TODO* unit test
+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
+
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```

docs/de-de/language-highlight.md

@@ -0,0 +1,11 @@
+# Hervorheben von Sprachen
+
+**docsify** verwendet [Prism](https://github.com/PrismJS/prism) um Quellcodeabschnitte in deinen Seiten hervorzuheben. Als Standardeinstellung werden nur CSS, JavaScipt und HTML unterstützt. Du kannst **Prism** auch mit weiteren Sprachen verwenden:
+
+```html
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
+```
+
+?> Vergleiche die [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) Liste für weitere Optionen.

docs/de-de/markdown.md

@@ -0,0 +1,57 @@
+# Markdown Einstellungen
+
+**docsify** verwendet [marked](https://github.com/chjj/marked), um Markdown umzuwandeln. Du kannst einstellen, wie es deine Markdown Seiten in HTML umwandelt, indem du `renderer` konfigurierst:
+
+```js
+window.$docsify = {
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  }
+}
+```
+
+?> Für mögliche Einstellungen, siehe [marked Dokumentation](https://github.com/chjj/marked#options-1)
+
+Du kannst die Regeln auch beliebig anpassen.
+
+```js
+window.$docsify = {
+  markdown: function(marked, renderer) {
+    // ...
+
+    return marked
+  }
+}
+```
+
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+mermaid.initialize({ startOnLoad: false });
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```
+

docs/de-de/more-pages.md

@@ -0,0 +1,92 @@
+# Noch mehr Seiten
+
+Wenn du mehr Seiten für deine Dokumentation brauchst, so kannst du weitere Markdown Dateien in deinem **docsify** Ordner erstellen. Eine Datei namens `guide.md` ist dann über `/#/guide` erreichbar.
+
+Nehmen wir als Beispiel folgende Verzeichnisstruktur:
+
+```text
+.
+├── docs
+|   └── README.md
+|   └── guide.md
+|   └── de-de
+|       └──README.md
+|       └──guide.md
+```
+
+Die passenden Routen sind dann
+
+```text
+docs/README.md        => http://domain.com
+docs/guide.md         => http://domain.com/guide
+docs/de-de/README.md  => http://domain.com/de-de/
+docs/de-de/guide.md   => http://domain.com/de-de/guide
+```
+
+## Seitenleiste mit Inhaltsverzeichnis anpassen
+
+Als Standardeinstellung wird das Inhaltsverzeichnis in der Seitenleiste automatisch basierend auf vorhandenen Markdown Dateien generiert. Wenn du das seitliche Inhaltsverzeichnis anpassen willst, kannst du eine Datei namens `_sidebar.md` erstellen (vergleiche [das seitliche Inhaltsverzeichnis für diese Dokumentation](https://github.com/QingWei-Li/docsify/blob/master/docs/de-de/_sidebar.md) als Beispiel):
+
+Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](configuration.md#load-sidebar).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadSidebar: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+Als Zweites erstellst du eine Datei namens `_sidebar.md`:
+
+```markdown
+<!-- docs/_sidebar.md -->
+
+- [Home](/)
+- [Guide](de-de/guide.md)
+```
+
+!> Solltest du Github Pages verwenden, musst du zusätzlich eine Datei namens `.nojekyll` in `./docs` erstellen, um zu verhindern, dass Github Dateien ignoriert, die mit einem Unterstrich anfangen.
+
+`_sidebar.md` wird in jedem Verzeichnislevel geladen. Sollte das aktuelle Verzeichnis keine Datei namens `_sidebar.md` haben, so sucht **docsify** in den übergeordneten Ordnern. Wenn du z.B. im Moment im Verzeichnis `/guide/quick-start` bist,  so wird `_sidebar.md` von der Datei `/guide/_sidebar.md` geladen.
+
+## Inhaltsverzeichnis
+
+Eine angepasste Seitenleist kann auch automatisch ein Inhaltsverzeichnis generieren, indem ein `subMaxLevel` gesetzt wird, vergleiche [sub-max-level Einstellungen](configuration.md#sub-max-level).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadSidebar: true,
+    subMaxLevel: 2
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+## Ignoring Subheaders
+
+When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it.
+
+```markdown
+# Getting Started
+
+## Header {docsify-ignore}
+This header won't appear in the sidebar table of contents.
+```
+
+To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page.
+
+```markdown
+# Getting Started {docsify-ignore-all}
+
+## Header
+This header won't appear in the sidebar table of contents.
+```
+
+Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used.

docs/de-de/plugins.md

@@ -0,0 +1,118 @@
+# Liste der Erweiterungen
+
+## Volltextsuche
+
+Als Standardeinstellung werden Hyperlinks auf der aktuellen Seite erkannt und der Inhalt in `localStorage` gespeichert. Du kannst den Pfad zu den Dateien auch anpassen:
+
+
+```html
+<script>
+  window.$docsify = {
+    search: 'auto', // Standard
+
+    search : [
+      '/',            // => /README.md
+      '/guide',       // => /guide.md
+      '/get-started', // => /get-started.md
+      '/de-de/',      // => /de-de/README.md
+    ],
+
+    // vollständige Parameter für die Einstellungen
+    search: {
+      maxAge: 86400000, // Verfallszeit, als Standard ein Tag
+      paths: [], // oder 'auto'
+      placeholder: 'Type to search',
+
+      // Lokalisation
+      placeholder: {
+        '/de-de/': 'Suche',
+        '/': 'Search'
+      },
+
+      noData: 'No Results!',
+
+      // Lokalisation
+      noData: {
+        '/de-de/': 'Keine Ergebnisse',
+        '/': 'No Results'
+      },
+
+      // Headline depth, 1 - 6
+      depth: 2
+    }
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+```
+
+## Google Analytics
+
+Installiere diese Erweiterung und passe die track id an:
+
+```html
+<script>
+  window.$docsify = {
+    ga: 'UA-XXXXX-Y'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+```
+
+Konfiguration über `data-ga`:
+
+```html
+<script src="//unpkg.com/docsify/lib/docsify.min.js" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+```
+
+## front matter
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/front-matter.min.js"></script>
+```
+
+## emoji
+
+Als Standardeinstellung werden emojis umgewandelt. Als Beispiel wird `:100:` umgewandelt in :100:. Aber das ist nicht genau, das es keine passende Nicht-emoji Zeichenfolge gibt. Solltest du emojis richtig umwandeln wollen, musst du diese Erweiterung verwenden.
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+```
+
+## Externes Skript
+
+Wenn das Skript auf der Seite ein externes ist (eine Javascript Datei über das `src` Attribut importiert), brauchst du diese Erweiterung, damit das funktioniert.
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/external-script.min.js"></script>
+```
+
+## Bilder zoomen
+
+Medium's Bilderzoom. Basierend auf [zoom-image](https://github.com/egoist/zoom-image).
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
+```
+
+## Edit on github
+
+Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
+
+
+## CodeSponsor
+
+See https://codesponsor.io
+
+
+```html
+<script>
+  window.$docsify = {
+    codesponsor: 'id'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/plugins/codesponsor.min.js"></script>
+```
+

docs/de-de/pwa.md

@@ -0,0 +1,115 @@
+# Offline Modus
+
+[Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/) (PWA) sind Erfahrungen die Vorzüge des Internets mit den Vorzügen von Apps verbinden. Wir können unsere Webseite verbessern, indem wir sie mit Hilfe von service workers auch **offline** und in schlechten Netzen interagierbar machen.
+
+Sie sind sehr einfach zu verwenden.
+
+## serviceWorker erstellen
+
+Erstelle eine Datei namens `sw.js` in deinem **docsify** Verzeichnis und kopiere folgenden Code:
+
+*sw.js*
+
+```js
+/* ===========================================================
+ * docsify sw.js
+ * ===========================================================
+ * Copyright 2016 @huxpro
+ * Licensed under Apache 2.0
+ * Register service worker.
+ * ========================================================== */
+
+const RUNTIME = 'docsify'
+const HOSTNAME_WHITELIST = [
+  self.location.hostname,
+  'fonts.gstatic.com',
+  'fonts.googleapis.com',
+  'unpkg.com'
+]
+
+// The Util Function to hack URLs of intercepted requests
+const getFixedUrl = (req) => {
+  var now = Date.now()
+  var url = new URL(req.url)
+
+  // 1. fixed http URL
+  // Just keep syncing with location.protocol
+  // fetch(httpURL) belongs to active mixed content.
+  // And fetch(httpRequest) is not supported yet.
+  url.protocol = self.location.protocol
+
+  // 2. add query for caching-busting.
+  // Github Pages served with Cache-Control: max-age=600
+  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
+  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
+  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
+  if (url.hostname === self.location.hostname) {
+    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
+  }
+  return url.href
+}
+
+/**
+ *  @Lifecycle Activate
+ *  New one activated when old isnt being used.
+ *
+ *  waitUntil(): activating ====> activated
+ */
+self.addEventListener('activate', event => {
+  event.waitUntil(self.clients.claim())
+})
+
+/**
+ *  @Functional Fetch
+ *  All network requests are being intercepted here.
+ *
+ *  void respondWith(Promise<Response> r)
+ */
+self.addEventListener('fetch', event => {
+  // Skip some of cross-origin requests, like those for Google Analytics.
+  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
+    // Stale-while-revalidate
+    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
+    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
+    const cached = caches.match(event.request)
+    const fixedUrl = getFixedUrl(event.request)
+    const fetched = fetch(fixedUrl, { cache: 'no-store' })
+    const fetchedCopy = fetched.then(resp => resp.clone())
+
+    // Call respondWith() with whatever we get first.
+    // If the fetch fails (e.g disconnected), wait for the cache.
+    // If there’s nothing in cache, wait for the fetch.
+    // If neither yields a response, return offline pages.
+    event.respondWith(
+      Promise.race([fetched.catch(_ => cached), cached])
+        .then(resp => resp || fetched)
+        .catch(_ => { /* eat any errors */ })
+    )
+
+    // Update the cache with the version we fetched (only for ok status)
+    event.waitUntil(
+      Promise.all([fetchedCopy, caches.open(RUNTIME)])
+        .then(([response, cache]) => response.ok && cache.put(event.request, response))
+        .catch(_ => { /* eat any errors */ })
+    )
+  }
+})
+```
+
+## Registrieren
+
+Jetzt registrieren wir die Funktion in der Datei `index.html`. Nur manche aktuellen Browser unterstützen die Funktion, wir müssen also prüfen:
+
+*index.html*
+
+```html
+<script>
+  if (typeof navigator.serviceWorker !== 'undefined') {
+    navigator.serviceWorker.register('sw.js')
+  }
+</script>
+```
+
+## Geniessen
+
+Du kannst die Website jetzt veröffentlichen und Benutzer können sie dann vollständig offline verwenden, sobald sie einmal geladen wurde :ghost: Du kannst das jetzt ausprobieren, indem du deine Internetverbindung ausschaltest und diese Seite neu lädst.

docs/de-de/quickstart.md

@@ -0,0 +1,88 @@
+# Schnellstart
+
+Es wird empfohlen, `docsify-cli` global zu installieren, welches bei der Inbetriebnahme und der lokalen Vorschau hilft.
+
+```bash
+npm i docsify-cli -g
+```
+
+## Inbetriebnahme
+
+Wenn du die Dokumentation in dem Unterordner `./docs` erstellen willst, kannst du den Befehl `init` verwenden.
+
+```bash
+docsify init ./docs
+```
+
+## Inhalt schreiben
+
+Nachdem der Befehl `init` vollständig ausgeführt wurde, kannst du folgende Dateien im Unterordner `./docs` finden:
+
+* `index.html` als zentrale Datei
+* `README.md` als die Startseite für die Dokumentation
+* `.nojekyll` verhindert, dass Github Pages Dateien ignoriert, die mit einem Unterstrich beginnen.
+
+Du kannst die Dokumentation über die Datei `./docs/README.md` nach Belieben ändern, und natürlich [weitere Seiten](de-de/more-pages.md) hinzufügen.
+
+## Vorschau der eigenen Seiten
+
+Du kannst einen lokalen Server mit dem Befehl `docsify serve` laufen lassen, und auf eine Vorschau deiner Webseite über `http://localhost:3000` zugreifen.
+
+```bash
+docsify serve docs
+```
+
+?> Für weitere Informationen hinsichtlich der Verwendung von `docsify-cli`, siehe [docsify-cli Dokumentation](https://github.com/QingWei-Li/docsify-cli).
+
+## Manuelle Inbetriebnahme
+
+Wenn du `npm` nicht verwenden möchtest, oder Probleme bei der Installation des Tools hast, kannst du auch manuell die Datei namens `index.html` erstellen:
+
+```html
+<!-- index.html -->
+
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</html>
+```
+
+Solltest du Python installiert haben, kannst du einen statischen Server laufen lassen, um eine Vorschau deiner Webseite anzuschauen:
+
+```bash
+cd docs && python -m SimpleHTTPServer 3000
+```
+
+## Ladedialog
+
+Wenn du möchtest, kann **docsify** einen Ladedialog anzeigen, während es deine Dokumentation umwandelt:
+
+```html
+  <!-- index.html -->
+
+  <div id="app">Please wait...</div>
+```
+
+Du solltest das `data-app` Attribut anpassen, wenn du `el` geändert hast:
+
+```html
+  <!-- index.html -->
+
+  <div data-app id="main">Please wait...</div>
+
+  <script>
+    window.$docsify = {
+      el: '#main'
+    }
+  </script>
+```
+
+Vergleiche [el Einstellungen](configuration.md#el).

docs/de-de/ssr.md

@@ -0,0 +1,123 @@
+# Server client renderer
+
+See https://docsify.now.sh
+
+Repo in https://github.com/QingWei-Li/docsify-ssr-demo
+
+## Why SSR?
+- Better SEO
+- Feeling cool
+
+## Quick start
+
+Install `now` and `docsify-cli` in your project.
+
+```bash
+npm i now docsify-cli -D
+```
+
+Edit `package.json`. If the documentation in `./docs` subdirectory.
+
+```json
+{
+  "name": "my-project",
+  "scripts": {
+    "start": "docsify start . -c ssr.config.js",
+    "deploy": "now -p"
+  },
+  "files": [
+    "docs"
+  ],
+  "docsify": {
+    "config": {
+      "basePath": 'https://docsify.js.org/',
+      "loadSidebar": true,
+      "loadNavbar": true,
+      "coverpage": true,
+      "name": "docsify"
+    }
+  }
+}
+```
+
+!> The `basePath` just like webpack `publicPath`. We can use local or remote files.
+
+We can preview in the local to see if it works.
+
+```bash
+npm start
+
+# open http://localhost:4000
+```
+
+Publish it!
+
+```bash
+now -p
+```
+
+Now, You have a support for SSR the docs site.
+
+## Custom template
+
+You can provide a templte for entire page's HTML. such as
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css" title="vue">
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+</body>
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+</html>
+```
+
+The template should contain these comments for rendered app content.
+ - `<!--inject-app-->`
+ - `<!--inject-config-->`
+
+## Configuration
+
+You can configure it in a special config file, or `package.json`.
+
+```js
+module.exports = {
+  template: './ssr.html',
+  config: {
+   // docsify config
+  }
+}
+```
+
+## Deploy for your VPS
+
+You can run `docsify start` directly on your Node server, or write your own server app with `docsify-server-renderer`.
+
+```js
+var Renderer = require('docsify-server-renderer')
+var readFileSync = require('fs').readFileSync
+
+// init
+var renderer = new Renderer({
+  template: readFileSync('./docs/index.template.html', 'utf-8').,
+  config: {
+    name: 'docsify',
+    repo: 'qingwei-li/docsify'
+  }
+})
+
+renderer.renderToString(url)
+  .then(html => {})
+  .catch(err => {})
+```

docs/de-de/themes.md

@@ -0,0 +1,56 @@
+# Themes
+
+Es gibt im Moment vier Themes zur Auswahl, ähnlich wie die Webseiten von [Vue](//vuejs.org) oder [buble](//buble.surge.sh), sowie eine weitere, dunkle von [@liril-net](https://github.com/liril-net).
+
+```html
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/dark.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/pure.css">
+```
+
+!> Komprimierte Dateien sind über `/lib/themes/` verfügbar.
+
+```html
+<!-- komprimierte Versionen -->
+
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css">
+```
+
+Solltest du weitere Themes erstellen, kannst du sie gerne der Allgemeinheit mit einem [pull request](https://github.com/QingWei-Li/docsify/pulls) zur Verfügung stellen.
+
+#### Klicke hier für eine Vorschau
+
+<div class="demo-theme-preview">
+  <a data-theme="vue">vue.css</a>
+  <a data-theme="buble">buble.css</a>
+  <a data-theme="dark">dark.css</a>
+  <a data-theme="pure">pure.css</a>
+</div>
+
+<style>
+  .demo-theme-preview a {
+    padding-right: 10px;
+  }
+
+  .demo-theme-preview a:hover {
+    cursor: pointer;
+    text-decoration: underline;
+  }
+</style>
+
+<script>
+  var preview = Docsify.dom.find('.demo-theme-preview');
+  var themes = Docsify.dom.findAll('[rel="stylesheet"]');
+
+  preview.onclick = function (e) {
+    var title = e.target.getAttribute('data-theme')
+
+    themes.forEach(function (theme) {
+      theme.disabled = theme.title !== title
+    });
+  };
+</script>

docs/de-de/vue.md

@@ -0,0 +1,100 @@
+# Kompatibel mit Vue
+
+Du kannst Vue Komponenten direkt in den Markdown Dateien verwenden, und sie werden umgewandelt. Du kannst dies zum Beispiel verwenden, um Vue Komponenten gleichzeitig zu demonstrieren und zu dokumentieren.
+
+## Einfache Verwendung
+
+Lade Vue in `./index.html`.
+
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify"></script>
+
+<!-- oder verwende die komprimierten Dateien -->
+<script src="//unpkg.com/vue/dist/vue.min.js"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+Dann kannst du sofort Vue Code in deinen Markdown Dateien verwenden. `new Vue({ el: '#main' })` wird als Standard ausgeführt, um Instanzen zu erschaffen.
+
+*README.md*
+
+```markdown
+# Vue guide
+
+`v-for` usage.
+
+```html
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+``
+
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+Du kannst manuell eine Vue Instanz initialisieren.
+
+*README.md*
+
+```markdown
+# Vue demo
+
+<div>hello {{ msg }}</div>
+
+<script>
+  new Vue({
+    el: '#main',
+    data: { msg: 'Vue' }
+  })
+</script>
+```
+
+!> In Markdown Dateien wird nur das Skript innerhalb des ersten script tag Blocks ausgeführt.
+
+## Kombiniere Vuep um Demos zu erschaffen
+
+[Vuep](https://github.com/QingWei-Li/vuep) ist eine Komponente zur Darstellung von Vue Komponenten mit einem Liveeditor und einer Vorschau.Unterstützt die Vue Komponenten spec und JSX.
+
+*index.html*
+
+```html
+<!-- injizieren von CSS -->
+<link rel="stylesheet" href="//unpkg.com/vuep/dist/vuep.css">
+
+<!-- injizieren von JS -->
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/vuep"></script>
+<script src="//unpkg.com/docsify"></script>
+
+<!-- oder verwende die komprimierten Dateien -->
+<script src="//unpkg.com/vue/dist/vue.min.js"></script>
+<script src="//unpkg.com/vuep/dist/vuep.min.js"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+*README.md*
+
+```markdown
+# Vuep
+
+<vuep template="#example"></vuep>
+
+<script v-pre type="text/x-template" id="example">
+  <template>
+    <div>Hello, {{ name }}!</div>
+  </template>
+
+  <script>
+    module.exports = {
+      data: function () {
+        return { name: 'Vue' }
+      }
+    }
+  </script>
+</script>
+```
+
+?> Zum Beispiel vergleich auch die [vuep Dokumentation](https://qingwei-li.github.io/vuep/).

docs/de-de/write-a-plugin.md

@@ -0,0 +1,94 @@
+# Schreiben einer Erweiterung
+
+Eine Erweiterung ist schlicht eine Funktion, welche `hook` als Argument nimmt. hook unterstützt dabei das Verwalten von asynchrononen Tasks.
+
+## Volle Konfiguration
+
+```js
+window.$docsify = {
+ plugins: [
+  function (hook, vm) {
+    hook.init(function() {
+      // Called when the script starts running, only trigger once, no arguments,
+    })
+
+    hook.beforeEach(function(content) {
+      // Invoked each time before parsing the Markdown file.
+      // ...
+      return content
+    })
+
+    hook.afterEach(function(html, next) {
+      // Invoked each time after the Markdown file is parsed.
+      // beforeEach and afterEach support asynchronous。
+      // ...
+      // call `next(html)` when task is done.
+      next(html)
+    })
+
+    hook.doneEach(function() {
+      // Invoked each time after the data is fully loaded, no arguments,
+      // ...
+    })
+
+    hook.mounted(function() {
+      // Called after initial completion. Only trigger once, no arguments.
+    })
+
+    hook.ready(function() {
+      // Called after initial completion, no arguments.
+    })
+  }
+ ]
+}
+```
+
+!> Du kannst auf interne Methoden über `window.Docsify` zugreifen. Greife auf die aktuelle Instanz über das zweite Argument zu.
+
+## Beispiel
+
+### footer
+
+Füge jeder Seite eine footer Komponente hinzu:
+
+```js
+window.$docsify = {
+  plugins: [
+    function (hook) {
+      var footer = [
+        '<hr/>',
+        '<footer>',
+        '<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
+        '<span>Proudly published with <a href="https://github.com/QingWei-Li/docsify" target="_blank">docsify</a>.</span>',
+        '</footer>'
+      ].join('')
+
+      hook.afterEach(function (html) {
+        return html + footer
+      })
+    }
+  ]
+}
+```
+
+
+### Edit Button
+
+```js
+window.$docsify = {
+  plugins: [
+    function(hook, vm) {
+      hook.beforeEach(function (html) {
+        var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file
+        var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n'
+
+        return editHtml
+          + html
+          + '\n----\n'
+          + 'Last modified {docsify-updated} '
+          + editHtml
+      })
+    }
+  ]
+}
+```

docs/deploy.md

@@ -0,0 +1,55 @@
+# Deploy
+
+Similar to [GitBook](https://www.gitbook.com), you can deploy files to GitHub Pages, GitLab Pages or VPS.
+
+## GitHub Pages
+
+There're three places to populate your docs for your Github repository:
+
+* `docs/` folder
+* master branch
+* gh-pages branch
+
+It is recommended that you save your files to the `./docs` subfolder of the `master` branch of your repository. Then select `master branch /docs folder` as your Github Pages source in your repositories' settings page.
+
+![github pages](_images/deploy-github-pages.png)
+
+!> You can also save files in the root directory and select `master branch`.
+
+## GitLab Pages
+
+If you are deploying your master branch, include `.gitlab-ci.yml` with the following script:
+
+?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
+
+``` YAML
+pages:
+  stage: deploy
+  script:
+  - mkdir .public
+  - cp -r * .public
+  - mv .public public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master
+```
+
+!> You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
+
+## VPS
+
+Try following nginx config.
+
+```nginx
+server {
+  listen 80;
+  server_name  your.domain.com;
+
+  location / {
+    alias /path/to/dir/of/docs;
+    index index.html;
+  }
+}
+```

docs/helpers.md

@@ -0,0 +1,59 @@
+# Doc helper
+
+docsify extends Markdown syntax to make your documents more readable.
+
+## important content
+
+Important content like:
+
+```markdown
+!> **Time** is money, my friend!
+```
+
+is rendered as:
+
+!> **Time** is money, my friend!
+
+## General tips
+
+General tips like:
+
+```markdown
+?> *TODO* unit test
+```
+
+are rendered as:
+
+?> *TODO* unit test
+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
+
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```
+

docs/index.html

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <link rel="icon" href="_media/favicon.ico">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
+  <meta name="description" content="A magical documentation generator.">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" title="dark" disabled>
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="buble" disabled>
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css" title="pure" disabled>
+  <style>
+    nav.app-nav li ul {
+      min-width: 100px;
+    }
+  </style>
+</head>
+<body>
+  <div id="app">Loading ...</div>
+</body>
+<script>
+  window.$docsify = {
+    alias: {
+      '.*?/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG',
+      '/.*/_navbar.md': '/_navbar.md'
+    },
+    auto2top: true,
+    coverpage: true,
+    executeScript: true,
+    loadSidebar: true,
+    loadNavbar: true,
+    mergeNavbar: true,
+    maxLevel: 4,
+    subMaxLevel: 2,
+    codesponsor: '7c9Ms7xRs-j_y_8abU03DA',
+    ga: 'UA-106147152-1',
+    name: 'docsify',
+    search: {
+      noData: {
+        '/de-de/': 'Keine Ergebnisse!',
+        '/zh-cn/': '没有结果!',
+        '/': 'No results!'
+      },
+      paths: 'auto',
+      placeholder: {
+        '/de-de/': 'Suche',
+        '/zh-cn/': '搜索',
+        '/': 'Search'
+      }
+    },
+    formatUpdated: '{MM}/{DD} {HH}:{mm}',
+    plugins: [
+      function(hook, vm) {
+        hook.beforeEach(function (html) {
+          var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs/' + vm.route.file
+          var editHtml = '[:memo: Edit Document](' + url + ')\n'
+
+          return editHtml
+            + html
+            + '\n----\n'
+            + 'Last modified {docsify-updated} '
+            + editHtml
+        })
+      }
+    ]
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/codesponsor.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+</html>

docs/language-highlight.md

@@ -0,0 +1,11 @@
+# language highlight
+
+**docsify** uses [Prism](https://github.com/PrismJS/prism) to highlight code blocks in your pages. By default it only supports CSS, JavaScipt and HTML. You can make **Prism** load additional languages:
+
+```html
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
+```
+
+?> Check the [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) list for more options.

docs/markdown.md

@@ -0,0 +1,55 @@
+# Markdown configuration
+
+**docsify** uses [marked](https://github.com/chjj/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
+
+```js
+window.$docsify = {
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  }
+}
+```
+
+?> Configuration Options Reference [marked documentation](https://github.com/chjj/marked#options-1)
+
+Even you can completely customize the parsing rules.
+
+```js
+window.$docsify = {
+  markdown: function(marked, renderer) {
+    // ...
+
+    return marked
+  }
+}
+```
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+mermaid.initialize({ startOnLoad: false });
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```

docs/more-pages.md

@@ -0,0 +1,92 @@
+# More pages
+
+If you need more pages, you can simply create more markdown files in your docsify directory. If you create a file named `guide.md`, then it is accessible via `/#/guide`.
+
+For example, the directory structure is as follows:
+
+```text
+.
+└── docs
+    ├── README.md
+    ├── guide.md
+    └── zh-cn
+        ├── README.md
+        └── guide.md
+```
+
+Matching routes
+
+```text
+docs/README.md        => http://domain.com
+docs/guide.md         => http://domain.com/guide
+docs/zh-cn/README.md  => http://domain.com/zh-cn/
+docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
+```
+
+## Custom sidebar
+
+By default, the table of contents in the sidebar is automatically generated based on your markdown files. If you need a custom sidebar, then you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/QingWei-Li/docsify/blob/master/docs/_sidebar.md) for an example):
+
+First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#load-sidebar).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadSidebar: true
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+Create the `_sidebar.md`:
+
+```markdown
+<!-- docs/_sidebar.md -->
+
+- [Home](/)
+- [Guide](guide.md)
+```
+
+!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
+
+`_sidebar.md` is loaded from each level directory. If the current directory doesn't have `_sidebar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`,  the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
+
+## Table of Contents
+
+A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [sub-max-level configuration](configuration.md#sub-max-level).
+
+```html
+<!-- index.html -->
+
+<script>
+  window.$docsify = {
+    loadSidebar: true,
+    subMaxLevel: 2
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+## Ignoring Subheaders
+
+When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it.
+
+```markdown
+# Getting Started
+
+## Header {docsify-ignore}
+This header won't appear in the sidebar table of contents.
+```
+
+To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page.
+
+```markdown
+# Getting Started {docsify-ignore-all}
+
+## Header
+This header won't appear in the sidebar table of contents.
+```
+
+Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used.

docs/plugins.md

@@ -0,0 +1,142 @@
+# List of Plugins
+
+## Full text search
+
+By default, the hyperlink on the current page is recognized and the content is saved in `localStorage`. You can also specify the path to the files.
+
+
+```html
+<script>
+  window.$docsify = {
+    search: 'auto', // default
+
+    search : [
+      '/',            // => /README.md
+      '/guide',       // => /guide.md
+      '/get-started', // => /get-started.md
+      '/zh-cn/',      // => /zh-cn/README.md
+    ],
+
+    // complete configuration parameters
+    search: {
+      maxAge: 86400000, // Expiration time, the default one day
+      paths: [], // or 'auto'
+      placeholder: 'Type to search',
+
+      // Localization
+      placeholder: {
+        '/zh-cn/': '搜索',
+        '/': 'Type to search'
+      },
+
+      noData: 'No Results!',
+
+      // Localization
+      noData: {
+        '/zh-cn/': '找不到结果',
+        '/': 'No Results'
+      },
+
+      // Headline depth, 1 - 6
+      depth: 2
+    }
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+```
+
+## Google Analytics
+
+Install the plugin and configure the track id.
+
+```html
+<script>
+  window.$docsify = {
+    ga: 'UA-XXXXX-Y'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+```
+
+Configure by `data-ga`.
+
+```html
+<script src="//unpkg.com/docsify/lib/docsify.min.js" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+```
+
+## front matter
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/front-matter.min.js"></script>
+```
+
+## emoji
+
+The default is to support parsing emoji. For example `:100:` will be parsed to :100:. But it is not precise because there is no matching non-emoji string. If you need to correctly parse the emoji string, you need install this plugin.
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+```
+
+## External Script
+
+If the script on the page is an external one (imports a js file via `src` attribute), you'll need this plugin to make it work.
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/external-script.min.js"></script>
+```
+
+## Zoom image
+
+Medium's Image Zoom. Based on [zoom-image](https://github.com/egoist/zoom-image).
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
+```
+
+## Edit on github
+
+Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
+
+## Demo code with instant preview and jsfiddle integration
+
+With this plugin, sample code can be rendered on the page instantly, so that the readers can see the preview immediately.
+When readers expand the demo box, the source code and description are shown there. if they click the button `Try in Jsfiddle`,
+`jsfiddle.net` will be open with the code of this sample, which allow readers to revise the code and try on their own.
+
+[Vue](https://njleonzhang.github.io/docsify-demo-box-vue/) and [React](https://njleonzhang.github.io/docsify-demo-box-react/) are both supported.
+
+## CodeSponsor
+
+See https://codesponsor.io
+
+```html
+<script>
+  window.$docsify = {
+    codesponsor: 'id'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/plugins/codesponsor.min.js"></script>
+```
+
+## Copy to Clipboard
+
+Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs.
+
+```html
+<link rel="stylesheet" href="//unpkg.com/docsify-copy-code/styles.css">
+<script src="//unpkg.com/docsify-copy-code/index.js"></script>
+```
+
+```javascript
+window.$docsify = {
+  plugins: [
+    window.DocsifyCopyCodePlugin.init()
+  ]
+}
+```
+
+See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details.

docs/pwa.md

@@ -0,0 +1,115 @@
+# Offline Mode
+
+[Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/) (PWA) are experiences that combine the best of the web with the best of apps. We can enhance our website with service workers to work **offline** or on low-quality networks.
+
+It is also very easy to use it.
+
+## Create serviceWorker
+
+Create a `sw.js` file in your documents root directory and copy the following code:
+
+*sw.js*
+
+```js
+/* ===========================================================
+ * docsify sw.js
+ * ===========================================================
+ * Copyright 2016 @huxpro
+ * Licensed under Apache 2.0
+ * Register service worker.
+ * ========================================================== */
+
+const RUNTIME = 'docsify'
+const HOSTNAME_WHITELIST = [
+  self.location.hostname,
+  'fonts.gstatic.com',
+  'fonts.googleapis.com',
+  'unpkg.com'
+]
+
+// The Util Function to hack URLs of intercepted requests
+const getFixedUrl = (req) => {
+  var now = Date.now()
+  var url = new URL(req.url)
+
+  // 1. fixed http URL
+  // Just keep syncing with location.protocol
+  // fetch(httpURL) belongs to active mixed content.
+  // And fetch(httpRequest) is not supported yet.
+  url.protocol = self.location.protocol
+
+  // 2. add query for caching-busting.
+  // Github Pages served with Cache-Control: max-age=600
+  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
+  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
+  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
+  if (url.hostname === self.location.hostname) {
+    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
+  }
+  return url.href
+}
+
+/**
+ *  @Lifecycle Activate
+ *  New one activated when old isnt being used.
+ *
+ *  waitUntil(): activating ====> activated
+ */
+self.addEventListener('activate', event => {
+  event.waitUntil(self.clients.claim())
+})
+
+/**
+ *  @Functional Fetch
+ *  All network requests are being intercepted here.
+ *
+ *  void respondWith(Promise<Response> r)
+ */
+self.addEventListener('fetch', event => {
+  // Skip some of cross-origin requests, like those for Google Analytics.
+  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
+    // Stale-while-revalidate
+    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
+    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
+    const cached = caches.match(event.request)
+    const fixedUrl = getFixedUrl(event.request)
+    const fetched = fetch(fixedUrl, { cache: 'no-store' })
+    const fetchedCopy = fetched.then(resp => resp.clone())
+
+    // Call respondWith() with whatever we get first.
+    // If the fetch fails (e.g disconnected), wait for the cache.
+    // If there’s nothing in cache, wait for the fetch.
+    // If neither yields a response, return offline pages.
+    event.respondWith(
+      Promise.race([fetched.catch(_ => cached), cached])
+        .then(resp => resp || fetched)
+        .catch(_ => { /* eat any errors */ })
+    )
+
+    // Update the cache with the version we fetched (only for ok status)
+    event.waitUntil(
+      Promise.all([fetchedCopy, caches.open(RUNTIME)])
+        .then(([response, cache]) => response.ok && cache.put(event.request, response))
+        .catch(_ => { /* eat any errors */ })
+    )
+  }
+})
+```
+
+## Register
+
+Now, register it in your `index.html`. It only works on some modern browsers, so we need to judge:
+
+*index.html*
+
+```html
+<script>
+  if (typeof navigator.serviceWorker !== 'undefined') {
+    navigator.serviceWorker.register('sw.js')
+  }
+</script>
+```
+
+## Enjoy it
+
+Release your website and start experiencing magical offline feature. :ghost: You can turn off Wi-Fi and refresh the current site to experience it.

docs/quickstart.md

@@ -0,0 +1,88 @@
+# Quick start
+
+It is recommended to install `docsify-cli` globally, which helps initializing and previewing the website locally.
+
+```bash
+npm i docsify-cli -g
+```
+
+## Initialize
+
+If you want to write the documentation in the `./docs` subdirectory, you can use the `init` command.
+
+```bash
+docsify init ./docs
+```
+
+## Writing content
+
+After the `init` is complete, you can see the file list in the `./docs` subdirectory.
+
+* `index.html` as the entry file
+* `README.md` as the home page
+* `.nojekyll` prevents GitHub Pages from ignoring files that begin with an underscore
+
+You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages.md).
+
+## Preview your site
+
+Run the local server with `docsify serve`. You can preview your site in your browser on `http://localhost:3000`.
+
+```bash
+docsify serve docs
+```
+
+?> For more use cases of `docsify-cli`, head over to the [docsify-cli documentation](https://github.com/QingWei-Li/docsify-cli).
+
+## Manual initialization
+
+If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`:
+
+```html
+<!-- index.html -->
+
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</html>
+```
+
+If you installed python on your system, you can easily use it to run a static server to preview your site.
+
+```bash
+cd docs && python -m SimpleHTTPServer 3000
+```
+
+## Loading dialog
+
+If you want, you can show a loading dialog before docsify starts to render your documentation:
+
+```html
+  <!-- index.html -->
+
+  <div id="app">Please wait...</div>
+```
+
+You should set the `data-app` attribute if you changed `el`:
+
+```html
+  <!-- index.html -->
+
+  <div data-app id="main">Please wait...</div>
+
+  <script>
+    window.$docsify = {
+      el: '#main'
+    }
+  </script>
+```
+
+Compare [el configuration](configuration.md#el).

docs/ssr.md

@@ -0,0 +1,123 @@
+# Server client renderer
+
+See https://docsify.now.sh
+
+Repo in https://github.com/QingWei-Li/docsify-ssr-demo
+
+## Why SSR?
+- Better SEO
+- Feeling cool
+
+## Quick start
+
+Install `now` and `docsify-cli` in your project.
+
+```bash
+npm i now docsify-cli -D
+```
+
+Edit `package.json`. If the documentation in `./docs` subdirectory.
+
+```json
+{
+  "name": "my-project",
+  "scripts": {
+    "start": "docsify start . -c ssr.config.js",
+    "deploy": "now -p"
+  },
+  "files": [
+    "docs"
+  ],
+  "docsify": {
+    "config": {
+      "basePath": 'https://docsify.js.org/',
+      "loadSidebar": true,
+      "loadNavbar": true,
+      "coverpage": true,
+      "name": "docsify"
+    }
+  }
+}
+```
+
+!> The `basePath` just like webpack `publicPath`. We can use local or remote files.
+
+We can preview in the local to see if it works.
+
+```bash
+npm start
+
+# open http://localhost:4000
+```
+
+Publish it!
+
+```bash
+now -p
+```
+
+Now, You have a support for SSR the docs site.
+
+## Custom template
+
+You can provide a templte for entire page's HTML. such as
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css" title="vue">
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+</body>
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+</html>
+```
+
+The template should contain these comments for rendered app content.
+ - `<!--inject-app-->`
+ - `<!--inject-config-->`
+
+## Configuration
+
+You can configure it in a special config file, or `package.json`.
+
+```js
+module.exports = {
+  template: './ssr.html',
+  config: {
+   // docsify config
+  }
+}
+```
+
+## Deploy for your VPS
+
+You can run `docsify start` directly on your Node server, or write your own server app with `docsify-server-renderer`.
+
+```js
+var Renderer = require('docsify-server-renderer')
+var readFileSync = require('fs').readFileSync
+
+// init
+var renderer = new Renderer({
+  template: readFileSync('./docs/index.template.html', 'utf-8').,
+  config: {
+    name: 'docsify',
+    repo: 'qingwei-li/docsify'
+  }
+})
+
+renderer.renderToString(url)
+  .then(html => {})
+  .catch(err => {})
+```

docs/themes.md

@@ -0,0 +1,56 @@
+# Themes
+
+There are currently three themes available. Copy [Vue](//vuejs.org) and [buble](//buble.surge.sh) website custom theme and [@liril-net](https://github.com/liril-net) contribution to the theme of the black style.
+
+```html
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/dark.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/pure.css">
+```
+
+!> Compressed files are available in `/lib/themes/`.
+
+```html
+<!-- compressed -->
+
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css">
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css">
+```
+
+If you have any ideas or would like to develop a new theme, you are welcome to submit a [pull request](https://github.com/QingWei-Li/docsify/pulls).
+
+#### Click to preview
+
+<div class="demo-theme-preview">
+  <a data-theme="vue">vue.css</a>
+  <a data-theme="buble">buble.css</a>
+  <a data-theme="dark">dark.css</a>
+  <a data-theme="pure">pure.css</a>
+</div>
+
+<style>
+  .demo-theme-preview a {
+    padding-right: 10px;
+  }
+
+  .demo-theme-preview a:hover {
+    cursor: pointer;
+    text-decoration: underline;
+  }
+</style>
+
+<script>
+  var preview = Docsify.dom.find('.demo-theme-preview');
+  var themes = Docsify.dom.findAll('[rel="stylesheet"]');
+
+  preview.onclick = function (e) {
+    var title = e.target.getAttribute('data-theme')
+
+    themes.forEach(function (theme) {
+      theme.disabled = theme.title !== title
+    });
+  };
+</script>

docs/vue.md

@@ -0,0 +1,99 @@
+# Compatible with Vue
+
+You can write Vue components directly in the Markdown file, and it will be parsed. You can use this feature to write vue demo and documentation together.
+
+## Basic usage
+
+Load the Vue in `./index.html`.
+
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify"></script>
+
+<!-- or use the compressed files -->
+<script src="//unpkg.com/vue/dist/vue.min.js"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+Then you can immediately write Vue code at Markdown file. `new Vue({ el: '#main' })` script is executed by default to create instance.
+
+*README.md*
+
+```markdown
+# Vue guide
+
+`v-for` usage.
+
+```html
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+You can manually initialize a Vue instance.
+
+*README.md*
+
+```markdown
+# Vue demo
+
+<div>hello {{ msg }}</div>
+
+<script>
+  new Vue({
+    el: '#main',
+    data: { msg: 'Vue' }
+  })
+</script>
+```
+
+!> In a Markdown file, only the script within the first script tag is executed.
+
+## Combine Vuep to write playground
+
+[Vuep](https://github.com/QingWei-Li/vuep) is a component for rendering Vue components with live editor and preview. Supports Vue component spec and JSX.
+
+*index.html*
+
+```html
+<!-- inject css file -->
+<link rel="stylesheet" href="//unpkg.com/vuep/dist/vuep.css">
+
+<!-- inject javascript file -->
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/vuep"></script>
+<script src="//unpkg.com/docsify"></script>
+
+<!-- or use the compressed files -->
+<script src="//unpkg.com/vue/dist/vue.min.js"></script>
+<script src="//unpkg.com/vuep/dist/vuep.min.js"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+*README.md*
+```markdown
+# Vuep
+
+<vuep template="#example"></vuep>
+
+<script v-pre type="text/x-template" id="example">
+  <template>
+    <div>Hello, {{ name }}!</div>
+  </template>
+
+  <script>
+    module.exports = {
+      data: function () {
+        return { name: 'Vue' }
+      }
+    }
+  </script>
+</script>
+```
+
+?> Example Refer to the [vuep documentation](https://qingwei-li.github.io/vuep/).

docs/write-a-plugin.md

@@ -0,0 +1,93 @@
+# Write a plugin
+
+A plugin is simply a function that takes `hook` as an argument. The hook supports handling of asynchronous tasks.
+
+## Full configuration
+
+```js
+window.$docsify = {
+ plugins: [
+  function (hook, vm) {
+    hook.init(function() {
+      // Called when the script starts running, only trigger once, no arguments,
+    })
+
+    hook.beforeEach(function(content) {
+      // Invoked each time before parsing the Markdown file.
+      // ...
+      return content
+    })
+
+    hook.afterEach(function(html, next) {
+      // Invoked each time after the Markdown file is parsed.
+      // beforeEach and afterEach support asynchronous。
+      // ...
+      // call `next(html)` when task is done.
+      next(html)
+    })
+
+    hook.doneEach(function() {
+      // Invoked each time after the data is fully loaded, no arguments,
+      // ...
+    })
+
+    hook.mounted(function() {
+      // Called after initial completion. Only trigger once, no arguments.
+    })
+
+    hook.ready(function() {
+      // Called after initial completion, no arguments.
+    })
+  }
+ ]
+}
+```
+
+!> You can get internal methods through `window.Docsify`. Get the current instance through the second argument.
+
+## Example
+
+#### footer
+
+Add footer component in each pages.
+
+```js
+window.$docsify = {
+  plugins: [
+    function (hook) {
+      var footer = [
+        '<hr/>',
+        '<footer>',
+        '<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
+        '<span>Proudly published with <a href="https://github.com/QingWei-Li/docsify" target="_blank">docsify</a>.</span>',
+        '</footer>'
+      ].join('')
+
+      hook.afterEach(function (html) {
+        return html + footer
+      })
+    }
+  ]
+}
+```
+
+### Edit Button
+
+```js
+window.$docsify = {
+  plugins: [
+    function(hook, vm) {
+      hook.beforeEach(function (html) {
+        var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file
+        var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n'
+
+        return editHtml
+          + html
+          + '\n----\n'
+          + 'Last modified {docsify-updated} '
+          + editHtml
+      })
+    }
+  ]
+}
+```

docs/zh-cn.md

@@ -1,100 +0,0 @@
-# docsify
-
-> 无需构建快速生成文档页
-
-## 特性
-- 无需构建，写完 markdown 直接发布
-- 支持自定义主题
-- 容易使用并且轻量
-
-## 快速上手
-
-### 创建项目
-新建一个空项目，接着创建一个 `docs` 目录并进入到 docs 目录下
-```shell
-mkdir my-project && cd my-project
-mkdir docs && cd docs
-```
-
-### 创建入口文件
-创建一个 `404.html` 文件，内容为
-```html
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-</body>
-<script src="//unpkg.com/docsify"></script>
-</html>
-```
-
-新建 `README.md` 文件，作为主页面
-
-```
-# Title
-
-## balabala
-```
-
-### 部署！
-将项目 `push` 到 GitHub 仓库后到设置页面开启 **GitHub Pages** 功能，选择 `docs/` 选项
-![image](https://cloud.githubusercontent.com/assets/7565692/20639058/e65e6d22-b3f3-11e6-9b8b-6309c89826f2.png)
-
-## 命令行工具
-
-方便快速创建文档目录，会读取项目的 `package.json` 里的选项作为 docsify 的配置，支持本地预览。
-
-### 安装
-```shell
-npm i docsify-cli -g
-```
-
-### 初始化文档
-
-默认初始化在当前目录，推荐将文档放在 `docs` 目录下
-```shell
-docsify init docs
-```
-
-### 启动本地服务
-启动一个 server 方便预览，打开 http://localhost:3000
-```shell
-docsify serve docs
-```
-
-更多选项参考 [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
-
-## 主题
-目前提供 vue.css 和 buble.css，直接修改 `404.html` 里的 cdn 地址即可
-```html
-<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
-```
-
-## 更多功能
-
-### 多页面
-`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/guide`。
-
-### 导航
-导航需要自己写在 `404.html` 文件里，效果参考本文档
-
-```html
-<nav>
-  <a href="/">En</a>
-  <a href="/zh-cn">中文</a>
-</nav>
-```
-
-### GitHub Corner
-参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `404.html` 里的 script 改成
-
-```html
-<script src="//unpkg.com/docsify" data-repo="your/repo"></script>
-```
-
-

docs/zh-cn/README.md

@@ -0,0 +1,29 @@
+## docsify
+
+> 一个神奇的文档网站生成工具
+
+## 是什么
+
+docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件，所有转换工作都是在运行时进行。
+
+这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)。
+
+查看[快速开始](zh-cn/quickstart.md)了解详情。
+
+## 特性
+- 无需构建，写完文档直接发布
+- 容易使用并且轻量 (~18kB gzipped)
+- 智能的全文搜索
+- 提供多套主题
+- 丰富的 API
+- 支持 Emoji
+- 兼容 IE10+
+- 支持 SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
+
+## 例子
+
+可以查看 [Showcase](https://github.com/QingWei-Li/docsify/#showcase) 来了解使用 docsify 的文档项目。
+
+## 捐赠
+
+如果你觉得 docsify 对你有帮助，或者想对我微小的工作一点资瓷，欢迎给我[捐赠](https://github.com/QingWei-Li/donate)。

docs/zh-cn/_sidebar.md

@@ -0,0 +1,23 @@
+- 入门
+  - [快速开始](zh-cn/quickstart.md)
+  - [多页文档](zh-cn/more-pages.md)
+  - [定制导航栏](zh-cn/custom-navbar.md)
+  - [封面](zh-cn/cover.md)
+
+- 定制化
+  - [配置项](zh-cn/configuration.md)
+  - [主题](zh-cn/themes.md)
+  - [插件列表](zh-cn/plugins.md)
+  - [开发插件](zh-cn/write-a-plugin.md)
+  - [Markdown 配置](zh-cn/markdown.md)
+  - [代码高亮](zh-cn/language-highlight.md)
+
+- 指南
+ - [部署](zh-cn/deploy.md)
+ - [文档助手](zh-cn/helpers.md)
+ - [兼容 Vue](zh-cn/vue.md)
+ - [CDN](zh-cn/cdn.md)
+ - [离线模式(PWA)](zh-cn/pwa.md)
+  - [服务端渲染 (SSR)](zh-cn/ssr.md)
+
+- [Changelog](zh-cn/changelog.md)

docs/zh-cn/cdn.md

@@ -0,0 +1,49 @@
+# CDN
+
+推荐使用 [unpkg](//unpkg.com) —— 能及时获取到最新版。
+
+## 获取最新版本
+
+根据 UNPKG 的规则，不指定特定版本号时将引入最新版。
+
+```html
+<!-- 引入 css -->
+<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+
+<!-- 引入 script -->
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+```
+
+## 获取指定版本
+
+如果担心频繁地版本更新又可能引入未知 Bug，我们也可以使用具体的版本。规则是 `//unpkg.com/docsify@VERSION/`
+
+```html
+<!-- 引入 css -->
+<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/themes/vue.css">
+
+<!-- 引入 script -->
+<script src="//unpkg.com/docsify@2.0.0/lib/docsify.js"></script>
+```
+
+!> 指定 *VERSION* 为 `latest` 可以强制每次都请求最新版本。
+
+## 压缩版
+
+CSS 的压缩文件位于 `/lib/themes/` 目录下
+
+```html
+<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+```
+
+JS 的压缩文件是原有文件路径的基础上加 `.min`后缀
+
+```html
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+## 其他 CDN
+
+- http://www.bootcdn.cn/docsify (支持国内)
+- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
+- https://cdnjs.com/libraries/docsify

docs/zh-cn/configuration.md

@@ -0,0 +1,372 @@
+# 配置项
+
+docsify 有两种配置参数的方式。一种是配置在 `window.$docsify` 里，另一种是给 `script` 标签添加 `data-*` 属性。
+
+```html
+<!-- 方法 1 -->
+<script>
+  window.$docsify = {
+    repo: 'QingWei-Li/docsify',
+    maxLevel: 3,
+    coverpage: true
+  }
+</script>
+
+<!-- 方法 2 -->
+<script
+  src="//unpkg.com/docsify"
+  data-repo="QingWei-Li/docsify"
+  data-max-level="3"
+  data-coverpage>
+</script>
+```
+
+两种方式可以共存，推荐第一种做法——直接配置 `window.$docsify` 对象——这会让你的配置更加清晰，同时也可以方便的将配置单独写到另一个文件里。
+
+!> 通过 `window.$docsify` 配置属性，需要将属性改成驼峰命名法。通过 `data-*` 属性配置，保持短横线的命名规则。
+
+
+## el
+
+- 类型：`String`
+- 默认值：`#app`
+
+docsify 初始化的挂载元素，可以是一个 CSS 选择器，默认为 `#app` 如果不存在就直接绑定在 `body` 上。
+
+```js
+window.$docsify = {
+  el: '#app'
+}
+```
+
+## repo
+
+- 类型：`String`
+- 默认值: `null`
+
+配置仓库地址或者 `username/repo` 的字符串，会在页面右上角渲染一个 [GitHub Corner](http://tholman.com/github-corners/) 挂件。
+
+```js
+window.$docsify = {
+  repo: 'QingWei-Li/docsify',
+  // or
+  repo: 'https://github.com/QingWei-Li/docsify/'
+}
+```
+
+
+## max-level
+
+- 类型：`Number`
+- 默认值: `6`
+
+默认情况下会抓取文档中所有标题渲染成目录，可配置最大支持渲染的标题层级。
+
+
+```js
+window.$docsify = {
+  maxLevel: 4
+}
+```
+
+## load-navbar
+
+- 类型：`Boolean|String`
+- 默认值: `false`
+
+加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar.md) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。
+
+```js
+window.$docsify = {
+  // 加载 _navbar.md
+  loadNavbar: true,
+
+  // 加载 nav.md
+  loadNavbar: 'nav.md'
+}
+```
+
+## load-sidebar
+
+- 类型：`Boolean|String`
+- 默认值: `false`
+
+加载自定义侧边栏，参考[多页文档](zh-cn/more-pages.md)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。
+
+```js
+window.$docsify = {
+  // 加载 _sidebar.md
+  loadSidebar: true,
+
+  // 加载 summary.md
+  loadSidebar: 'summary.md'
+}
+```
+
+## sub-max-level
+
+- 类型：`Number`
+- 默认值: `0`
+
+自定义侧边栏后默认不会再生成目录，你也可以通过设置生成目录的最大层级开启这个功能。
+
+
+```js
+window.$docsify = {
+  subMaxLevel: 2
+}
+```
+
+
+## auto2top
+
+- 类型：`Boolean`
+- 默认值: `false`
+
+切换页面后是否自动跳转到页面顶部。
+
+```js
+window.$docsify = {
+  auto2top: true
+}
+```
+
+
+## homepage
+
+- 类型：`String`
+- 默认值: `README.md`
+
+设置首页文件加载路径。适合不想将 `README.md` 作为入口文件渲染，或者是文档存放在其他位置的情况使用。
+
+```js
+window.$docsify = {
+  // 入口文件改为 /home.md
+  homepage: 'home.md',
+
+  // 文档和仓库根目录下的 README.md 内容一致
+  homepage: 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
+}
+```
+
+## base-path
+
+- 类型：`String`
+
+文档加载的根路径，可以是二级路径或者是其他域名的路径。
+
+```js
+window.$docsify = {
+  basePath: '/path/',
+
+  // 直接渲染其他域名的文档
+  basePath: 'https://docsify.js.org/',
+
+  // 甚至直接渲染其他仓库 readme
+  basePath: 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
+}
+```
+
+
+## coverpage
+
+- 类型：`Boolean|String`
+- 默认值: `false`
+
+启用[封面页](zh-cn/cover.md)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。
+
+```js
+window.$docsify = {
+  coverpage: true,
+
+  // 自定义文件名
+  coverpage: 'cover.md'
+}
+```
+
+## name
+
+- 类型：`String`
+
+
+文档标题，会显示在侧边栏顶部。
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+## name-link
+
+- 类型：`String`
+- 默认值：`window.location.pathname`
+
+点击文档标题后跳转的链接地址。
+
+```js
+window.$docsify = {
+  nameLink: '/',
+
+  // 按照路由切换
+  nameLink: {
+    '/zh-cn/': '/zh-cn/',
+    '/': '/'
+  }
+}
+```
+
+## markdown
+
+- 类型: `Object|Function`
+
+参考 [Markdown 配置](zh-cn/markdown.md)。
+
+```js
+window.$docsify = {
+  // object
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  },
+
+  // function
+  markdown: function (marked, renderer) {
+    // ...
+    return marked
+  }
+}
+```
+
+## theme-color
+
+- 类型：`String`
+
+替换主题色。利用 [CSS3 支持变量](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性，对于老的浏览器有 polyfill 处理。
+
+```js
+window.$docsify = {
+  themeColor: '#3F51B5'
+}
+```
+
+## alias
+
+- 类型：`Object`
+
+定义路由别名，可以更自由的定义路由规则。 支持正则。
+
+
+```js
+window.$docsify = {
+  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
+    '/zh-cn/changelog': '/changelog',
+    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+  }
+}
+```
+
+## auto-header
+
+- 类型：`Boolean`
+
+同时设置 `loadSidebar` 和 `autoHeader` 后，可以根据 `_sidebar.md` 的内容自动为每个页面增加标题。[#78](https://github.com/QingWei-Li/docsify/issues/78)
+
+```js
+window.$docsify = {
+  loadSidebar: true,
+  autoHeader: true
+}
+```
+
+## execute-script
+
+- 类型：`Boolean`
+
+执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes.md))。 如果 Vue 存在，则自动开启。
+
+```js
+window.$docsify = {
+  executeScript: true
+}
+```
+
+```markdown
+## This is test
+
+<script>
+  console.log(2333)
+</script>
+
+```
+
+注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 [external-script](plugins.md?id=外链脚本-external-script) 插件。
+
+## no-emoji
+
+禁用 emoji 解析。
+
+```js
+window.$docsify = {
+  noEmoji: true
+}
+```
+
+## merge-navbar
+
+小屏设备下合并导航栏到侧边栏。
+
+```js
+window.$docsify = {
+  mergeNavbar: true
+}
+```
+
+## format-updated
+
+我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`.
+参考 https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+Currently it defaults to _blank, would be nice if configurable:
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```
+
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```

docs/zh-cn/cover.md

@@ -0,0 +1,58 @@
+# 封面
+
+通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](configuration.md#coverpage)。
+
+## 基本用法
+
+封面的生成同样是从 markdown 文件渲染来的。开启渲染封面功能后在文档根目录创建 `_coverpage.md` 文件。渲染效果如本文档。
+
+*index.html*
+
+```html
+<script>
+  window.$docsify = {
+    coverpage: true
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+*_coverpage.md*
+
+```markdown
+![logo](_media/icon.svg)
+
+# docsify
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~12kb gzipped)
+- Multiple themes
+- Not build static html files
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+```
+
+
+
+!> 一份文档只会在根目录下加载封面，其他页面或者二级目录下都不会加载。
+
+## 自定义背景
+
+目前的背景是随机生成的渐变色，我们自定义背景色或者背景图。在文档末尾用添加图片的 Markdown 语法设置背景。
+
+*_coverpage.md*
+
+```markdown
+# docsify
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+
+<!-- 背景图片 -->
+![](_media/bg.png)
+<!-- 背景色 -->
+![color](#f0f0f0)
+```

docs/zh-cn/custom-navbar.md

@@ -0,0 +1,67 @@
+# 自定义导航栏
+
+我们可以直接在 HTML 里定义导航栏，要注意链接要以 `#/` 开头。
+
+*index.html*
+
+```html
+<body>
+  <nav>
+    <a href="#/">EN</a>
+    <a href="#/zh-cn/">中文</a>
+  </nav>
+  <div id="app"></div>
+</body>
+```
+
+
+## 配置文件
+
+那我们可以通过 Markdown 文件来配置导航。首先配置 `loadNavbar`，默认加载的文件为 `_navbar.md`。具体配置规则见[配置项#load-navbar](configuration.md#load-navbar)。
+
+*index.html*
+
+
+```html
+<script>
+  window.$docsify = {
+    loadNavbar: true
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+*_navbar.md*
+
+```markdown
+- [En](/)
+- [中文](/zh-cn/)
+```
+
+`_navbar.md` 加载逻辑和 `sidebar` 文件一致，从每层目录下获取。例如当前路由为 `/zh-cn/custom-navbar` 那么是从 `/zh-cn/_navbar.md` 获取导航栏。
+
+## 嵌套
+
+如果导航内容过多，可以写成嵌套的列表，会被渲染成下拉列表的形式。
+
+*_navbar.md*
+
+
+```markdown
+- 基础
+ - [快速开始](zh-cn/quickstart.md)
+ - [多页文档](zh-cn/more-pages.md)
+ - [定制导航栏](zh-cn/custom-navbar.md)
+ - [封面](zh-cn/cover.md)
+
+- 配置
+  - [配置项](zh-cn/configuration.md)
+  - [主题](zh-cn/themes.md)
+  - [使用插件](zh-cn/plugins.md)
+  - [Markdown 配置](zh-cn/markdown.md)
+  - [代码高亮](zh-cn/language-highlight.md)
+```
+
+效果图
+
+![嵌套导航栏](_images/zh-cn/nested-navbar.png "嵌套导航栏")

docs/zh-cn/deploy.md

@@ -0,0 +1,58 @@
+# 部署
+
+和 GitBook 生成的文档一样，我们可以直接把文档网站部署到 GitHub Pages 或者 VPS 上。
+
+## GitHub Pages
+
+GitHub Pages 支持从三个地方读取文件
+- `docs/` 目录
+- master 分支
+- gh-pages 分支
+
+我们推荐直接将文档放在 `docs/` 目录下，在设置页面开启 **GitHub Pages** 功能并选择 `master branch /docs folder` 选项。
+
+![github pages](_images/deploy-github-pages.png)
+
+!> 可以将文档放在根目录下，然后选择 **master 分支** 作为文档目录。
+
+
+## GitLab Pages
+
+If you are deploying your master branch, include `.gitlab-ci.yml` with the following script:
+
+?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
+
+``` YAML
+pages:
+  stage: deploy
+  script:
+  - mkdir .public
+  - cp -r * .public
+  - mv .public public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master
+```
+
+!> You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
+
+
+## VPS
+
+和部署所有静态网站一样，只需将服务器的访问根目录设定为 `index.html` 文件。
+
+例如 nginx 的配置
+
+```nginx
+server {
+  listen 80;
+  server_name  your.domain.com;
+
+  location / {
+    alias /path/to/dir/of/docs;
+    index index.html;
+  }
+}
+```

docs/zh-cn/helpers.md

@@ -0,0 +1,58 @@
+# 文档助手
+
+docsify 扩展了一些 Markdown 语法，可以让文档更易读。
+
+
+## 强调内容
+
+适合显示重要的提示信息，语法为 `!> 内容`。
+
+```markdown
+!> 一段重要的内容，可以和其他 **Markdown** 语法混用。
+```
+
+!> 一段重要的内容，可以和其他 **Markdown** 语法混用。
+
+
+## 普通提示
+
+普通的提示信息，比如写 TODO 或者参考内容等。
+
+```markdown
+?> *TODO* 完善示例
+```
+
+?> *TODO* 完善示例
+
+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
+
+
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```

docs/zh-cn/language-highlight.md

@@ -0,0 +1,11 @@
+# 代码高亮
+
+内置的代码高亮工具是 [Prism](https://github.com/PrismJS/prism)，默认支持 CSS、JavaScript 和 HTML。如果需要高亮其语言——例如 PHP——可以手动引入代码高亮插件。
+
+```html
+<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-php.js"></script>
+```
+
+?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)。

docs/zh-cn/markdown.md

@@ -0,0 +1,56 @@
+# Markdown 配置
+
+内置的 Markdown 解析器是 [marked](https://github.com/chjj/marked)，可以修改它的配置。同时可以直接配置 `renderer`。
+
+```js
+window.$docsify = {
+  markdown: {
+    smartypants: true,
+    renderer: {
+      link: function() {
+        // ...
+      }
+    }
+  }
+}
+```
+
+?> 完整配置参数参考 [marked 文档](https://github.com/chjj/marked#options-1)
+
+当然也可以完全定制 Markdown 解析规则。
+
+```js
+window.$docsify = {
+  markdown: function(marked, renderer) {
+    // ...
+
+    return marked
+  }
+}
+```
+
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+mermaid.initialize({ startOnLoad: false });
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```

docs/zh-cn/more-pages.md

@@ -0,0 +1,87 @@
+# 多页文档
+
+如果需要创建多个页面，或者需要多级路由的网站，在 docsify 里也能很容易的实现。例如创建一个 `guide.md` 文件，那么对应的路由就是 `/#/guide`。
+
+假设你的目录结构如下：
+
+```text
+-| docs/
+  -| README.md
+  -| guide.md
+  -| zh-cn/
+    -| README.md
+    -| guide.md
+```
+
+那么对应的访问页面将是
+
+```text
+docs/README.md        => http://domain.com
+docs/guide.md         => http://domain.com/guide
+docs/zh-cn/README.md  => http://domain.com/zh-cn/
+docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
+```
+
+## 定制侧边栏
+
+默认情况下，侧边栏会根据当前文档的标题生成目录。也可以设置文档链接，通过 Markdown 文件生成，效果如当前的文档的侧边栏。
+
+首先配置 `loadSidebar` 选项，具体配置规则见[配置项#load-sidebar](configuration.md#load-sidebar)。
+
+```html
+<script>
+  window.$docsify = {
+    loadSidebar: true
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+接着创建 `_sidebar.md` 文件，内容如下
+
+```markdown
+- [首页](zh-cn/)
+- [指南](zh-cn/guide)
+```
+
+!> 需要在文档根目录创建 `.nojekyll` 命名的空文件，阻止 GitHub Pages 忽略命名是下划线开头的文件。
+
+
+`_sidebar.md` 的加载逻辑是从每层目录下获取文件，如果当前目录不存在该文件则回退到上一级目录。例如当前路径为 `/zh-cn/more-pages` 则从 `/zh-cn/_sidebar.md` 获取文件，如果不存在则从 `/_sidebar.md` 获取。
+
+## 显示目录
+
+自定义侧边栏同时也可以开启目录功能。设置 `subMaxLevel` 配置项，具体介绍见 [配置项#sub-max-level](zh-cn/configuration#sub-max-level)。
+
+```html
+<script>
+  window.$docsify = {
+    loadSidebar: true,
+    subMaxLevel: 2
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+## Ignoring Subheaders
+
+When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it.
+
+```markdown
+# Getting Started
+
+## Header {docsify-ignore}
+This header won't appear in the sidebar table of contents.
+```
+
+To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page.
+
+```markdown
+# Getting Started {docsify-ignore-all}
+
+## Header
+This header won't appear in the sidebar table of contents.
+```
+
+Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used.
+

docs/zh-cn/plugins.md

@@ -0,0 +1,113 @@
+# 插件列表
+
+## 全文搜索 - Search
+
+全文搜索插件会根据当前页面上的超链接获取文档内容，在 `localStorage` 内建立文档索引。默认过期时间为一天，当然我们可以自己指定需要缓存的文件列表或者配置过期时间。
+
+
+```html
+<script>
+  window.$docsify = {
+    search: 'auto', // 默认值
+
+    search : [
+      '/',            // => /README.md
+      '/guide',       // => /guide.md
+      '/get-started', // => /get-started.md
+      '/zh-cn/',      // => /zh-cn/README.md
+    ],
+
+    // 完整配置参数
+    search: {
+      maxAge: 86400000, // 过期时间，单位毫秒，默认一天
+      paths: [], // or 'auto'
+      placeholder: 'Type to search',
+
+      // 支持本地化
+      placeholder: {
+        '/zh-cn/': '搜索',
+        '/': 'Type to search'
+      },
+
+      noData: 'No Results!',
+
+      // 支持本地化
+      noData: {
+        '/zh-cn/': '找不到结果',
+        '/': 'No Results'
+      },
+
+      // 搜索标题的最大程级, 1 - 6
+      depth: 2
+    }
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
+```
+
+## 谷歌统计 - Google Analytics
+
+需要配置 track id 才能使用。
+
+```html
+<script>
+  window.$docsify = {
+    ga: 'UA-XXXXX-Y'
+  }
+</script>
+<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+```
+
+也可以通过 `data-ga` 配置 id。
+
+```html
+<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+```
+
+## emoji
+
+默认是提供 emoji 解析的，能将类似 `:100:` 解析成 :100:。但是它不是精准的，因为没有处理非 emoji 的字符串。如果你需要正确解析 emoji 字符串，你可以引入这个插件。
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
+```
+
+## 外链脚本 - External Script
+
+如果文档里的 script 是内联脚本，可以直接执行；而如果是外链脚本（即 js 文件内容由 `src` 属性引入），则需要使用此插件。
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/external-script.js"></script>
+```
+
+## 图片缩放 - Zoom image
+
+Medium's 风格的图片缩放插件. 基于 [zoom-image](https://github.com/egoist/zoom-image)。
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
+```
+
+
+## Edit on github
+
+Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
+
+
+## CodeSponsor
+
+See https://codesponsor.io
+
+
+```html
+<script>
+  window.$docsify = {
+    codesponsor: 'id'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/plugins/codesponsor.min.js"></script>
+```
+

docs/zh-cn/pwa.md

@@ -0,0 +1,113 @@
+# 离线模式
+
+[Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/)(PWA) 是一项融合 Web 和 Native 应用各项优点的解决方案。我们可以利用其支持离线功能的特点，让我们的网站可以在信号差或者离线状态下正常运行。
+要使用它也非常容易。
+
+## 创建 serviceWorker
+这里已经整理好了一份代码，你只需要在网站根目录下创建一个 `sw.js` 文件，并粘贴下面的代码。
+
+*sw.js*
+
+```js
+/* ===========================================================
+ * docsify sw.js
+ * ===========================================================
+ * Copyright 2016 @huxpro
+ * Licensed under Apache 2.0
+ * Register service worker.
+ * ========================================================== */
+
+const RUNTIME = 'docsify'
+const HOSTNAME_WHITELIST = [
+  self.location.hostname,
+  'fonts.gstatic.com',
+  'fonts.googleapis.com',
+  'unpkg.com'
+]
+
+// The Util Function to hack URLs of intercepted requests
+const getFixedUrl = (req) => {
+  var now = Date.now()
+  var url = new URL(req.url)
+
+  // 1. fixed http URL
+  // Just keep syncing with location.protocol
+  // fetch(httpURL) belongs to active mixed content.
+  // And fetch(httpRequest) is not supported yet.
+  url.protocol = self.location.protocol
+
+  // 2. add query for caching-busting.
+  // Github Pages served with Cache-Control: max-age=600
+  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
+  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
+  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
+  if (url.hostname === self.location.hostname) {
+    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
+  }
+  return url.href
+}
+
+/**
+ *  @Lifecycle Activate
+ *  New one activated when old isnt being used.
+ *
+ *  waitUntil(): activating ====> activated
+ */
+self.addEventListener('activate', event => {
+  event.waitUntil(self.clients.claim())
+})
+
+/**
+ *  @Functional Fetch
+ *  All network requests are being intercepted here.
+ *
+ *  void respondWith(Promise<Response> r)
+ */
+self.addEventListener('fetch', event => {
+  // Skip some of cross-origin requests, like those for Google Analytics.
+  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
+    // Stale-while-revalidate
+    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
+    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
+    const cached = caches.match(event.request)
+    const fixedUrl = getFixedUrl(event.request)
+    const fetched = fetch(fixedUrl, { cache: 'no-store' })
+    const fetchedCopy = fetched.then(resp => resp.clone())
+
+    // Call respondWith() with whatever we get first.
+    // If the fetch fails (e.g disconnected), wait for the cache.
+    // If there’s nothing in cache, wait for the fetch.
+    // If neither yields a response, return offline pages.
+    event.respondWith(
+      Promise.race([fetched.catch(_ => cached), cached])
+        .then(resp => resp || fetched)
+        .catch(_ => { /* eat any errors */ })
+    )
+
+    // Update the cache with the version we fetched (only for ok status)
+    event.waitUntil(
+      Promise.all([fetchedCopy, caches.open(RUNTIME)])
+        .then(([response, cache]) => response.ok && cache.put(event.request, response))
+        .catch(_ => { /* eat any errors */ })
+    )
+  }
+})
+```
+
+## 注册
+
+现在，到 `index.html` 里注册它。这个功能只能工作在一些现代浏览器上，所以我们需要加个判断。
+
+*index.html*
+
+```html
+<script>
+  if (typeof navigator.serviceWorker !== 'undefined') {
+    navigator.serviceWorker.register('sw.js')
+  }
+</script>
+```
+
+## 体验一下
+
+发布你的网站，并开始享受离线模式的魔力吧！:ghost: 当然你现在看到的 docsify 的文档网站已经支持离线模式了，你可以关掉 Wi-Fi 体验一下。

docs/zh-cn/quickstart.md

@@ -0,0 +1,84 @@
+# 快速开始
+
+推荐安装 `docsify-cli` 工具，可以方便创建及本地预览文档网站。
+
+```bash
+npm i docsify-cli -g
+```
+
+## 初始化项目
+
+如果想在项目的 `./docs` 目录里写文档，直接通过 `init` 初始化项目。
+
+```bash
+docsify init ./docs
+```
+
+## 开始写文档
+
+初始化成功后，可以看到 `./docs` 目录下创建的几个文件
+
+- `index.html` 入口文件
+- `README.md` 会做为主页内容渲染
+- `.nojekyll` 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
+
+直接编辑 `docs/README.md` 就能更新网站内容，当然也可以[写多个页面](zh-cn/more-pages.md)。
+
+## 本地预览网站
+
+运行一个本地服务器通过 `docsify serve` 可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://localhost:3000 。
+
+```bash
+docsify serve docs
+```
+
+?> 更多命令行工具用法，参考 [docsify-cli 文档](https://github.com/QingWei-Li/docsify-cli)。
+
+## 手动初始化
+
+如果不喜欢 npm 或者觉得安装工具太麻烦，我们其实只需要直接创建一个 `index.html` 文件。
+
+*index.html*
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+</body>
+<script src="//unpkg.com/docsify"></script>
+</html>
+```
+
+如果系统里安装 Python 的话，也可以很轻易的启动一个静态服务器。
+
+```bash
+cd docs && python -m SimpleHTTPServer 3000
+```
+
+## Loading 提示
+
+初始化时会显示 `Loading...` 内容，你可以自定义提示信息。
+
+*index.html*
+```html
+  <div id="app">加载中</div>
+```
+
+如果更改了 `el` 的配置，需要将该元素加上 `data-app` 属性。
+
+*index.html*
+```html
+  <div data-app id="main">加载中</div>
+
+  <script>
+    window.$docsify = {
+      el: '#main'
+    }
+  </script>
+```

docs/zh-cn/ssr.md

@@ -0,0 +1,118 @@
+# 服务端渲染（SSR）
+
+先看例子 https://docsify.now.sh
+
+项目地址在 https://github.com/QingWei-Li/docsify-ssr-demo
+
+![](https://dn-mhke0kuv.qbox.me/2bfef08c592706108055.png)
+
+文档依旧是部署在 GitHub Pages 上，Node 服务部署在 now.sh 里，渲染的内容是从 GitHub Pages 上同步过来的。所以静态部署文档的服务器和服务端渲染的 Node 服务器是分开的，也就是说你还是可以用之前的方式更新文档，并不需要每次都部署。
+
+
+
+## 快速开始
+
+如果你熟悉 `now` 的使用，接下来的介绍就很简单了。先创建一个新项目，并安装 `now` 和 `docsify-cli`。
+
+```bash
+mkdir my-ssr-demo && cd my-ssr-demo
+npm init -y
+npm i now docsify-cli -D
+```
+
+配置 `package.json`
+
+```json
+{
+  "scripts": {
+    "start": "docsify start .",
+    "deploy": "now -p"
+  },
+  "docsify": {
+    "config": {
+      "basePath": "https://docsify.js.org/",
+      "loadSidebar": true,
+      "loadNavbar": true
+    }
+  }
+}
+```
+
+如果你还没有创建文档，可以参考[之前的文章](https://zhuanlan.zhihu.com/p/24540753)。其中 `basePath` 为文档所在的路径，可以填你的 docsify 文档网站。
+
+配置可以单独写在配置文件内，然后通过 `--config config.js` 加载。
+
+渲染的基础模版也可以自定义，配置在 `template` 属性上，例如
+
+```js
+"docsify": {
+    "template": "./ssr.html",
+    "config": {
+      "basePath": "https://docsify.js.org/",
+      "loadSidebar": true,
+      "loadNavbar": true
+    }
+  }
+```
+
+*ssr.html*
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <link rel="icon" href="_media/favicon.ico">
+  <meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
+  <meta name="description" content="A magical documentation generator.">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+</body>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+</html>
+
+```
+
+其中 `<!--inject-app-->` 和 `<!--inject-config-->` 为占位符，会自动将渲染后的 html 和配置内容注入到页面上。
+
+现在，你可以运行 `npm start` 预览效果，如果没有问题就通过 `npm run deploy` 部署服务。
+
+```bash
+npm start
+# open http://localhost:4000
+
+npm run deploy
+# now ...
+```
+
+
+
+## 更多玩法
+
+`docsify start` 其实是依赖了 [`docsify-server-renderer`](https://npmarket.surge.sh/?name=docsify-server-renderer) 模块，如果你感兴趣，你完全可以用它自己实现一个 server，可以加入缓存等功能。
+
+```js
+var Renderer = require('docsify-server-renderer')
+var readFileSync = require('fs').readFileSync
+
+// init
+var renderer = new Renderer({
+  template: readFileSync('./docs/index.template.html', 'utf-8').,
+  config: {
+    name: 'docsify',
+    repo: 'qingwei-li/docsify'
+  }
+})
+
+renderer.renderToString(url)
+  .then(html => {})
+  .catch(err => {})
+```
+
+当然文档文件和 server 也是可以部署在一起的，`basePath` 不是一个 URL 的话就会当做文件路径处理，也就是从服务器上加载资源。

docs/zh-cn/themes.md

@@ -0,0 +1,56 @@
+# 主题
+
+目前提供三套主题可供选择，模仿 [Vue](//vuejs.org) 和 [buble](//buble.surge.sh) 官网订制的主题样式。还有 [@liril-net](https://github.com/liril-net) 贡献的黑色风格的主题。
+
+```html
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/dark.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/pure.css">
+```
+
+!> CSS 的压缩文件位于 `/lib/themes/`
+
+```html
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css">
+```
+
+如果你有其他想法或者想开发别的主题，欢迎提 [PR](https://github.com/QingWei-Li/docsify/pulls)。
+
+#### 点击切换主题
+
+
+<div class="demo-theme-preview">
+  <a data-theme="vue">vue.css</a>
+  <a data-theme="buble">buble.css</a>
+  <a data-theme="dark">dark.css</a>
+  <a data-theme="pure">pure.css</a>
+</div>
+
+
+<style>
+  .demo-theme-preview a {
+    padding-right: 10px;
+  }
+
+  .demo-theme-preview a:hover {
+    text-decoration: underline;
+    cursor: pointer;
+  }
+</style>
+
+<script>
+  var preview = Docsify.dom.find('.demo-theme-preview');
+  var themes = Docsify.dom.findAll('[rel="stylesheet"]');
+
+  preview.onclick = function (e) {
+    var title = e.target.getAttribute('data-theme')
+
+    themes.forEach(function (theme) {
+      theme.disabled = theme.title !== title
+    });
+  };
+</script>

docs/zh-cn/vue.md

@@ -0,0 +1,112 @@
+# 兼容 Vue
+
+你可以直接在 Markdown 文件里写 Vue 代码，它将被执行。我们可以用它写一些 Vue 的 Demo 或者示例代码。
+
+
+## 基础用法
+
+在 `index.html` 里引入 Vue。
+
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+接着就可以愉快地在 Markdown 里写 Vue 了。默认会执行 `new Vue({ el: '#main' })` 创建示例。
+
+*README.md*
+
+```markdown
+# Vue 介绍
+
+`v-for` 的用法
+
+```html
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+``
+
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+当然你也可以手动初始化 Vue，这样你可以自定义一些配置。
+
+*README.md*
+
+```markdown
+# Vue 的基本用法
+
+<div>hello {{ msg }}</div>
+
+<script>
+  new Vue({
+    el: '#main',
+    data: { msg: 'Vue' }
+  })
+</script>
+```
+
+!> 一个 Markdown 文件里只有第一个 `script` 标签内的内容会被执行。
+
+## 搭配 Vuep 写 Playground
+
+[Vuep](https://github.com/QingWei-Li/vuep) 是一个提供在线编辑和预览效果的 Vue 组件，搭配 docsify 可以直接在文档里写 Vue 的示例代码，支持 Vue component spec 和 JSX。
+
+*index.html*
+
+```html
+<!-- inject css file -->
+<link rel="stylesheet" href="//unpkg.com/vuep/dist/vuep.css">
+
+<!-- inject javascript file -->
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/vuep"></script>
+<script src="//unpkg.com/docsify"></script>
+
+<!-- or use the compressed files -->
+<script src="//unpkg.com/vue/dist/vue.min.js"></script>
+<script src="//unpkg.com/vuep/dist/vuep.min.js"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+```
+
+*README.md*
+```markdown
+# Vuep 使用
+
+<vuep template="#example"></vuep>
+
+<script v-pre type="text/x-template" id="example">
+  <template>
+    <div>Hello, {{ name }}!</div>
+  </template>
+
+  <script>
+    module.exports = {
+      data: function () {
+        return { name: 'Vue' }
+      }
+    }
+  </script>
+</script>
+```
+
+<vuep template="#example"></vuep>
+
+<script v-pre type="text/x-template" id="example">
+  <template>
+    <div>Hello, {{ name }}!</div>
+  </template>
+
+  <script>
+    module.exports = {
+      data: function () {
+        return { name: 'Vue' }
+      }
+    }
+  </script>
+</script>
+
+?> 具体效果参考 [Vuep 文档](https://qingwei-li.github.io/vuep/)。

docs/zh-cn/write-a-plugin.md

@@ -0,0 +1,94 @@
+# 自定义插件
+
+docsify 提供了一套插件机制，其中提供的钩子（hook）支持处理异步逻辑，可以很方便的扩展功能。
+
+## 完整功能
+
+```js
+window.$docsify = {
+ plugins: [
+  function (hook, vm) {
+    hook.init(function() {
+      // 初始化时调用，只调用一次，没有参数。
+    })
+
+    hook.beforeEach(function(content) {
+      // 每次开始解析 Markdown 内容时调用
+      // ...
+      return content
+    })
+
+    hook.afterEach(function(html, next) {
+      // 解析成 html 后调用。beforeEach 和 afterEach 支持处理异步逻辑
+      // ...
+      // 异步处理完成后调用 next(html) 返回结果
+      next(html)
+    })
+
+    hook.doneEach(function() {
+      // 每次路由切换时数据全部加载完成后调用，没有参数。
+      // ...
+    })
+
+    hook.mounted(function() {
+      // 初始化完成后调用 ，只调用一次，没有参数。
+    })
+
+    hook.ready(function() {
+      // 初始化并第一次加完成数据后调用，没有参数。
+    })
+  }
+ ]
+}
+```
+
+!> 如果需要用 docsify 的内部方法，可以通过 `window.Docsify` 获取，通过 `vm` 获取当前实例。
+
+## 例子
+
+
+### footer
+
+给每个页面的末尾加上 `footer`
+
+```js
+window.$docsify = {
+  plugins: [
+    function (hook) {
+      var footer = [
+        '<hr/>',
+        '<footer>',
+        '<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
+        '<span>Proudly published with <a href="https://github.com/QingWei-Li/docsify" target="_blank">docsify</a>.</span>',
+        '</footer>'
+      ].join('')
+
+      hook.afterEach(function (html) {
+        return html + footer
+      })
+    }
+  ]
+}
+```
+
+
+### Edit Button
+
+```js
+window.$docsify = {
+  plugins: [
+    function(hook, vm) {
+      hook.beforeEach(function (html) {
+        var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file
+        var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n'
+
+        return editHtml
+          + html
+          + '\n----\n'
+          + 'Last modified {docsify-updated} '
+          + editHtml
+      })
+    }
+  ]
+}
+```

lerna.json

@@ -0,0 +1,7 @@
+{
+  "lerna": "2.0.0-rc.5",
+  "packages": [
+    "packages/*"
+  ],
+  "version": "0.0.0"
+}

lib/plugins/codesponsor.js

@@ -0,0 +1,64 @@
+(function () {
+'use strict';
+
+var DEFAULT_OPTIONS = {
+  theme: 'light',
+  image: 'show'
+};
+
+function tpl (id, options) {
+  var qs = [];
+
+  for (var key in options) {
+    qs.push((key + "=" + (options[key])));
+  }
+
+  var div = Docsify.dom.create('div');
+
+  Docsify.dom.toggleClass(div, 'codesponsor');
+  div.innerHTML = "<iframe\n      scrolling=0\n      frameborder=0\n      width=250\n      height=250\n      id=\"code-sponsor-embed-iframe\"\n      src=\"https://app.codesponsor.io/widgets/" + id + "?" + (qs.join('&')) + "\">\n    </iframe>";
+
+  return div
+}
+
+function appIframe (id, opts) {
+  var html = tpl(id, opts);
+
+  Docsify.dom.before(Docsify.dom.find('section.content'), html);
+}
+
+function appendStyle () {
+  Docsify.dom.style("\n    .codesponsor {\n      position: relative;\n      float: right;\n      right: 10px;\n      top: 10px;\n    }\n\n    @media screen and (min-width: 1600px) {\n      body.sticky .codesponsor {\n        position: fixed;\n      }\n\n      .codesponsor {\n        position: absolute;\n        bottom: 10px;\n        top: auto;\n        float: none;\n      }\n    }\n  ");
+}
+
+var install = function (hook, vm) {
+  var config = vm.config.codesponsor;
+  var id;
+
+  if (typeof config === 'string') {
+    id = config;
+    config = {};
+  } else {
+    id = config.id;
+  }
+
+  var opts = Docsify.util.merge(DEFAULT_OPTIONS, config);
+
+  if (!id) {
+    throw Error('codesponsor plugin need id')
+  }
+
+  if (Docsify.util.isMobile) {
+    return
+  }
+
+  // Append style
+  hook.ready(function () {
+    appendStyle();
+    appIframe(id, opts);
+  });
+};
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+
+}());

lib/plugins/codesponsor.min.js

@@ -0,0 +1 @@
+!function(){"use strict";function o(o,n){var i=[];for(var s in n)i.push(s+"="+n[s]);var e=Docsify.dom.create("div");return Docsify.dom.toggleClass(e,"codesponsor"),e.innerHTML='<iframe\n      scrolling=0\n      frameborder=0\n      width=250\n      height=250\n      id="code-sponsor-embed-iframe"\n      src="https://app.codesponsor.io/widgets/'+o+"?"+i.join("&")+'">\n    </iframe>',e}function n(n,i){var s=o(n,i);Docsify.dom.before(Docsify.dom.find("section.content"),s)}function i(){Docsify.dom.style("\n    .codesponsor {\n      position: relative;\n      float: right;\n      right: 10px;\n      top: 10px;\n    }\n\n    @media screen and (min-width: 1600px) {\n      body.sticky .codesponsor {\n        position: fixed;\n      }\n\n      .codesponsor {\n        position: absolute;\n        bottom: 10px;\n        top: auto;\n        float: none;\n      }\n    }\n  ")}var s={theme:"light",image:"show"},e=function(o,e){var t,r=e.config.codesponsor;"string"==typeof r?(t=r,r={}):t=r.id;var c=Docsify.util.merge(s,r);if(!t)throw Error("codesponsor plugin need id");Docsify.util.isMobile||o.ready(function(){i(),n(t,c)})};window.$docsify.plugins=[].concat(e,window.$docsify.plugins)}();

lib/plugins/emoji.js

@@ -0,0 +1,905 @@
+(function () {
+'use strict';
+
+var AllGithubEmoji = [
+  '+1',
+  '100',
+  '1234',
+  '8ball',
+  'a',
+  'ab',
+  'abc',
+  'abcd',
+  'accept',
+  'aerial_tramway',
+  'airplane',
+  'alarm_clock',
+  'alien',
+  'ambulance',
+  'anchor',
+  'angel',
+  'anger',
+  'angry',
+  'anguished',
+  'ant',
+  'apple',
+  'aquarius',
+  'aries',
+  'arrow_backward',
+  'arrow_double_down',
+  'arrow_double_up',
+  'arrow_down',
+  'arrow_down_small',
+  'arrow_forward',
+  'arrow_heading_down',
+  'arrow_heading_up',
+  'arrow_left',
+  'arrow_lower_left',
+  'arrow_lower_right',
+  'arrow_right',
+  'arrow_right_hook',
+  'arrow_up',
+  'arrow_up_down',
+  'arrow_up_small',
+  'arrow_upper_left',
+  'arrow_upper_right',
+  'arrows_clockwise',
+  'arrows_counterclockwise',
+  'art',
+  'articulated_lorry',
+  'astonished',
+  'athletic_shoe',
+  'atm',
+  'b',
+  'baby',
+  'baby_bottle',
+  'baby_chick',
+  'baby_symbol',
+  'back',
+  'baggage_claim',
+  'balloon',
+  'ballot_box_with_check',
+  'bamboo',
+  'banana',
+  'bangbang',
+  'bank',
+  'bar_chart',
+  'barber',
+  'baseball',
+  'basketball',
+  'bath',
+  'bathtub',
+  'battery',
+  'bear',
+  'bee',
+  'beer',
+  'beers',
+  'beetle',
+  'beginner',
+  'bell',
+  'bento',
+  'bicyclist',
+  'bike',
+  'bikini',
+  'bird',
+  'birthday',
+  'black_circle',
+  'black_joker',
+  'black_large_square',
+  'black_medium_small_square',
+  'black_medium_square',
+  'black_nib',
+  'black_small_square',
+  'black_square_button',
+  'blossom',
+  'blowfish',
+  'blue_book',
+  'blue_car',
+  'blue_heart',
+  'blush',
+  'boar',
+  'boat',
+  'bomb',
+  'book',
+  'bookmark',
+  'bookmark_tabs',
+  'books',
+  'boom',
+  'boot',
+  'bouquet',
+  'bow',
+  'bowling',
+  'bowtie',
+  'boy',
+  'bread',
+  'bride_with_veil',
+  'bridge_at_night',
+  'briefcase',
+  'broken_heart',
+  'bug',
+  'bulb',
+  'bullettrain_front',
+  'bullettrain_side',
+  'bus',
+  'busstop',
+  'bust_in_silhouette',
+  'busts_in_silhouette',
+  'cactus',
+  'cake',
+  'calendar',
+  'calling',
+  'camel',
+  'camera',
+  'cancer',
+  'candy',
+  'capital_abcd',
+  'capricorn',
+  'car',
+  'card_index',
+  'carousel_horse',
+  'cat',
+  'cat2',
+  'cd',
+  'chart',
+  'chart_with_downwards_trend',
+  'chart_with_upwards_trend',
+  'checkered_flag',
+  'cherries',
+  'cherry_blossom',
+  'chestnut',
+  'chicken',
+  'children_crossing',
+  'chocolate_bar',
+  'christmas_tree',
+  'church',
+  'cinema',
+  'circus_tent',
+  'city_sunrise',
+  'city_sunset',
+  'cl',
+  'clap',
+  'clapper',
+  'clipboard',
+  'clock1',
+  'clock10',
+  'clock1030',
+  'clock11',
+  'clock1130',
+  'clock12',
+  'clock1230',
+  'clock130',
+  'clock2',
+  'clock230',
+  'clock3',
+  'clock330',
+  'clock4',
+  'clock430',
+  'clock5',
+  'clock530',
+  'clock6',
+  'clock630',
+  'clock7',
+  'clock730',
+  'clock8',
+  'clock830',
+  'clock9',
+  'clock930',
+  'closed_book',
+  'closed_lock_with_key',
+  'closed_umbrella',
+  'cloud',
+  'clubs',
+  'cn',
+  'cocktail',
+  'coffee',
+  'cold_sweat',
+  'collision',
+  'computer',
+  'confetti_ball',
+  'confounded',
+  'confused',
+  'congratulations',
+  'construction',
+  'construction_worker',
+  'convenience_store',
+  'cookie',
+  'cool',
+  'cop',
+  'copyright',
+  'corn',
+  'couple',
+  'couple_with_heart',
+  'couplekiss',
+  'cow',
+  'cow2',
+  'credit_card',
+  'crescent_moon',
+  'crocodile',
+  'crossed_flags',
+  'crown',
+  'cry',
+  'crying_cat_face',
+  'crystal_ball',
+  'cupid',
+  'curly_loop',
+  'currency_exchange',
+  'curry',
+  'custard',
+  'customs',
+  'cyclone',
+  'dancer',
+  'dancers',
+  'dango',
+  'dart',
+  'dash',
+  'date',
+  'de',
+  'deciduous_tree',
+  'department_store',
+  'diamond_shape_with_a_dot_inside',
+  'diamonds',
+  'disappointed',
+  'disappointed_relieved',
+  'dizzy',
+  'dizzy_face',
+  'do_not_litter',
+  'dog',
+  'dog2',
+  'dollar',
+  'dolls',
+  'dolphin',
+  'door',
+  'doughnut',
+  'dragon',
+  'dragon_face',
+  'dress',
+  'dromedary_camel',
+  'droplet',
+  'dvd',
+  'e-mail',
+  'ear',
+  'ear_of_rice',
+  'earth_africa',
+  'earth_americas',
+  'earth_asia',
+  'egg',
+  'eggplant',
+  'eight',
+  'eight_pointed_black_star',
+  'eight_spoked_asterisk',
+  'electric_plug',
+  'elephant',
+  'email',
+  'end',
+  'envelope',
+  'envelope_with_arrow',
+  'es',
+  'euro',
+  'european_castle',
+  'european_post_office',
+  'evergreen_tree',
+  'exclamation',
+  'expressionless',
+  'eyeglasses',
+  'eyes',
+  'facepunch',
+  'factory',
+  'fallen_leaf',
+  'family',
+  'fast_forward',
+  'fax',
+  'fearful',
+  'feelsgood',
+  'feet',
+  'ferris_wheel',
+  'file_folder',
+  'finnadie',
+  'fire',
+  'fire_engine',
+  'fireworks',
+  'first_quarter_moon',
+  'first_quarter_moon_with_face',
+  'fish',
+  'fish_cake',
+  'fishing_pole_and_fish',
+  'fist',
+  'five',
+  'flags',
+  'flashlight',
+  'flipper',
+  'floppy_disk',
+  'flower_playing_cards',
+  'flushed',
+  'foggy',
+  'football',
+  'footprints',
+  'fork_and_knife',
+  'fountain',
+  'four',
+  'four_leaf_clover',
+  'fr',
+  'free',
+  'fried_shrimp',
+  'fries',
+  'frog',
+  'frowning',
+  'fu',
+  'fuelpump',
+  'full_moon',
+  'full_moon_with_face',
+  'game_die',
+  'gb',
+  'gem',
+  'gemini',
+  'ghost',
+  'gift',
+  'gift_heart',
+  'girl',
+  'globe_with_meridians',
+  'goat',
+  'goberserk',
+  'godmode',
+  'golf',
+  'grapes',
+  'green_apple',
+  'green_book',
+  'green_heart',
+  'grey_exclamation',
+  'grey_question',
+  'grimacing',
+  'grin',
+  'grinning',
+  'guardsman',
+  'guitar',
+  'gun',
+  'haircut',
+  'hamburger',
+  'hammer',
+  'hamster',
+  'hand',
+  'handbag',
+  'hankey',
+  'hash',
+  'hatched_chick',
+  'hatching_chick',
+  'headphones',
+  'hear_no_evil',
+  'heart',
+  'heart_decoration',
+  'heart_eyes',
+  'heart_eyes_cat',
+  'heartbeat',
+  'heartpulse',
+  'hearts',
+  'heavy_check_mark',
+  'heavy_division_sign',
+  'heavy_dollar_sign',
+  'heavy_exclamation_mark',
+  'heavy_minus_sign',
+  'heavy_multiplication_x',
+  'heavy_plus_sign',
+  'helicopter',
+  'herb',
+  'hibiscus',
+  'high_brightness',
+  'high_heel',
+  'hocho',
+  'honey_pot',
+  'honeybee',
+  'horse',
+  'horse_racing',
+  'hospital',
+  'hotel',
+  'hotsprings',
+  'hourglass',
+  'hourglass_flowing_sand',
+  'house',
+  'house_with_garden',
+  'hurtrealbad',
+  'hushed',
+  'ice_cream',
+  'icecream',
+  'id',
+  'ideograph_advantage',
+  'imp',
+  'inbox_tray',
+  'incoming_envelope',
+  'information_desk_person',
+  'information_source',
+  'innocent',
+  'interrobang',
+  'iphone',
+  'it',
+  'izakaya_lantern',
+  'jack_o_lantern',
+  'japan',
+  'japanese_castle',
+  'japanese_goblin',
+  'japanese_ogre',
+  'jeans',
+  'joy',
+  'joy_cat',
+  'jp',
+  'key',
+  'keycap_ten',
+  'kimono',
+  'kiss',
+  'kissing',
+  'kissing_cat',
+  'kissing_closed_eyes',
+  'kissing_heart',
+  'kissing_smiling_eyes',
+  'koala',
+  'koko',
+  'kr',
+  'lantern',
+  'large_blue_circle',
+  'large_blue_diamond',
+  'large_orange_diamond',
+  'last_quarter_moon',
+  'last_quarter_moon_with_face',
+  'laughing',
+  'leaves',
+  'ledger',
+  'left_luggage',
+  'left_right_arrow',
+  'leftwards_arrow_with_hook',
+  'lemon',
+  'leo',
+  'leopard',
+  'libra',
+  'light_rail',
+  'link',
+  'lips',
+  'lipstick',
+  'lock',
+  'lock_with_ink_pen',
+  'lollipop',
+  'loop',
+  'loud_sound',
+  'loudspeaker',
+  'love_hotel',
+  'love_letter',
+  'low_brightness',
+  'm',
+  'mag',
+  'mag_right',
+  'mahjong',
+  'mailbox',
+  'mailbox_closed',
+  'mailbox_with_mail',
+  'mailbox_with_no_mail',
+  'man',
+  'man_with_gua_pi_mao',
+  'man_with_turban',
+  'mans_shoe',
+  'maple_leaf',
+  'mask',
+  'massage',
+  'meat_on_bone',
+  'mega',
+  'melon',
+  'memo',
+  'mens',
+  'metal',
+  'metro',
+  'microphone',
+  'microscope',
+  'milky_way',
+  'minibus',
+  'minidisc',
+  'mobile_phone_off',
+  'money_with_wings',
+  'moneybag',
+  'monkey',
+  'monkey_face',
+  'monorail',
+  'moon',
+  'mortar_board',
+  'mount_fuji',
+  'mountain_bicyclist',
+  'mountain_cableway',
+  'mountain_railway',
+  'mouse',
+  'mouse2',
+  'movie_camera',
+  'moyai',
+  'muscle',
+  'mushroom',
+  'musical_keyboard',
+  'musical_note',
+  'musical_score',
+  'mute',
+  'nail_care',
+  'name_badge',
+  'neckbeard',
+  'necktie',
+  'negative_squared_cross_mark',
+  'neutral_face',
+  'new',
+  'new_moon',
+  'new_moon_with_face',
+  'newspaper',
+  'ng',
+  'night_with_stars',
+  'nine',
+  'no_bell',
+  'no_bicycles',
+  'no_entry',
+  'no_entry_sign',
+  'no_good',
+  'no_mobile_phones',
+  'no_mouth',
+  'no_pedestrians',
+  'no_smoking',
+  'non-potable_water',
+  'nose',
+  'notebook',
+  'notebook_with_decorative_cover',
+  'notes',
+  'nut_and_bolt',
+  'o',
+  'o2',
+  'ocean',
+  'octocat',
+  'octopus',
+  'oden',
+  'office',
+  'ok',
+  'ok_hand',
+  'ok_woman',
+  'older_man',
+  'older_woman',
+  'on',
+  'oncoming_automobile',
+  'oncoming_bus',
+  'oncoming_police_car',
+  'oncoming_taxi',
+  'one',
+  'open_book',
+  'open_file_folder',
+  'open_hands',
+  'open_mouth',
+  'ophiuchus',
+  'orange_book',
+  'outbox_tray',
+  'ox',
+  'package',
+  'page_facing_up',
+  'page_with_curl',
+  'pager',
+  'palm_tree',
+  'panda_face',
+  'paperclip',
+  'parking',
+  'part_alternation_mark',
+  'partly_sunny',
+  'passport_control',
+  'paw_prints',
+  'peach',
+  'pear',
+  'pencil',
+  'pencil2',
+  'penguin',
+  'pensive',
+  'performing_arts',
+  'persevere',
+  'person_frowning',
+  'person_with_blond_hair',
+  'person_with_pouting_face',
+  'phone',
+  'pig',
+  'pig2',
+  'pig_nose',
+  'pill',
+  'pineapple',
+  'pisces',
+  'pizza',
+  'point_down',
+  'point_left',
+  'point_right',
+  'point_up',
+  'point_up_2',
+  'police_car',
+  'poodle',
+  'poop',
+  'post_office',
+  'postal_horn',
+  'postbox',
+  'potable_water',
+  'pouch',
+  'poultry_leg',
+  'pound',
+  'pouting_cat',
+  'pray',
+  'princess',
+  'punch',
+  'purple_heart',
+  'purse',
+  'pushpin',
+  'put_litter_in_its_place',
+  'question',
+  'rabbit',
+  'rabbit2',
+  'racehorse',
+  'radio',
+  'radio_button',
+  'rage',
+  'rage1',
+  'rage2',
+  'rage3',
+  'rage4',
+  'railway_car',
+  'rainbow',
+  'raised_hand',
+  'raised_hands',
+  'raising_hand',
+  'ram',
+  'ramen',
+  'rat',
+  'recycle',
+  'red_car',
+  'red_circle',
+  'registered',
+  'relaxed',
+  'relieved',
+  'repeat',
+  'repeat_one',
+  'restroom',
+  'revolving_hearts',
+  'rewind',
+  'ribbon',
+  'rice',
+  'rice_ball',
+  'rice_cracker',
+  'rice_scene',
+  'ring',
+  'rocket',
+  'roller_coaster',
+  'rooster',
+  'rose',
+  'rotating_light',
+  'round_pushpin',
+  'rowboat',
+  'ru',
+  'rugby_football',
+  'runner',
+  'running',
+  'running_shirt_with_sash',
+  'sa',
+  'sagittarius',
+  'sailboat',
+  'sake',
+  'sandal',
+  'santa',
+  'satellite',
+  'satisfied',
+  'saxophone',
+  'school',
+  'school_satchel',
+  'scissors',
+  'scorpius',
+  'scream',
+  'scream_cat',
+  'scroll',
+  'seat',
+  'secret',
+  'see_no_evil',
+  'seedling',
+  'seven',
+  'shaved_ice',
+  'sheep',
+  'shell',
+  'ship',
+  'shipit',
+  'shirt',
+  'shit',
+  'shoe',
+  'shower',
+  'signal_strength',
+  'six',
+  'six_pointed_star',
+  'ski',
+  'skull',
+  'sleeping',
+  'sleepy',
+  'slot_machine',
+  'small_blue_diamond',
+  'small_orange_diamond',
+  'small_red_triangle',
+  'small_red_triangle_down',
+  'smile',
+  'smile_cat',
+  'smiley',
+  'smiley_cat',
+  'smiling_imp',
+  'smirk',
+  'smirk_cat',
+  'smoking',
+  'snail',
+  'snake',
+  'snowboarder',
+  'snowflake',
+  'snowman',
+  'sob',
+  'soccer',
+  'soon',
+  'sos',
+  'sound',
+  'space_invader',
+  'spades',
+  'spaghetti',
+  'sparkle',
+  'sparkler',
+  'sparkles',
+  'sparkling_heart',
+  'speak_no_evil',
+  'speaker',
+  'speech_balloon',
+  'speedboat',
+  'squirrel',
+  'star',
+  'star2',
+  'stars',
+  'station',
+  'statue_of_liberty',
+  'steam_locomotive',
+  'stew',
+  'straight_ruler',
+  'strawberry',
+  'stuck_out_tongue',
+  'stuck_out_tongue_closed_eyes',
+  'stuck_out_tongue_winking_eye',
+  'sun_with_face',
+  'sunflower',
+  'sunglasses',
+  'sunny',
+  'sunrise',
+  'sunrise_over_mountains',
+  'surfer',
+  'sushi',
+  'suspect',
+  'suspension_railway',
+  'sweat',
+  'sweat_drops',
+  'sweat_smile',
+  'sweet_potato',
+  'swimmer',
+  'symbols',
+  'syringe',
+  'tada',
+  'tanabata_tree',
+  'tangerine',
+  'taurus',
+  'taxi',
+  'tea',
+  'telephone',
+  'telephone_receiver',
+  'telescope',
+  'tennis',
+  'tent',
+  'thought_balloon',
+  'three',
+  'thumbsdown',
+  'thumbsup',
+  'ticket',
+  'tiger',
+  'tiger2',
+  'tired_face',
+  'tm',
+  'toilet',
+  'tokyo_tower',
+  'tomato',
+  'tongue',
+  'top',
+  'tophat',
+  'tractor',
+  'traffic_light',
+  'train',
+  'train2',
+  'tram',
+  'triangular_flag_on_post',
+  'triangular_ruler',
+  'trident',
+  'triumph',
+  'trolleybus',
+  'trollface',
+  'trophy',
+  'tropical_drink',
+  'tropical_fish',
+  'truck',
+  'trumpet',
+  'tshirt',
+  'tulip',
+  'turtle',
+  'tv',
+  'twisted_rightwards_arrows',
+  'two',
+  'two_hearts',
+  'two_men_holding_hands',
+  'two_women_holding_hands',
+  'u5272',
+  'u5408',
+  'u55b6',
+  'u6307',
+  'u6708',
+  'u6709',
+  'u6e80',
+  'u7121',
+  'u7533',
+  'u7981',
+  'u7a7a',
+  'uk',
+  'umbrella',
+  'unamused',
+  'underage',
+  'unlock',
+  'up',
+  'us',
+  'v',
+  'vertical_traffic_light',
+  'vhs',
+  'vibration_mode',
+  'video_camera',
+  'video_game',
+  'violin',
+  'virgo',
+  'volcano',
+  'vs',
+  'walking',
+  'waning_crescent_moon',
+  'waning_gibbous_moon',
+  'warning',
+  'watch',
+  'water_buffalo',
+  'watermelon',
+  'wave',
+  'wavy_dash',
+  'waxing_crescent_moon',
+  'waxing_gibbous_moon',
+  'wc',
+  'weary',
+  'wedding',
+  'whale',
+  'whale2',
+  'wheelchair',
+  'white_check_mark',
+  'white_circle',
+  'white_flower',
+  'white_large_square',
+  'white_medium_small_square',
+  'white_medium_square',
+  'white_small_square',
+  'white_square_button',
+  'wind_chime',
+  'wine_glass',
+  'wink',
+  'wolf',
+  'woman',
+  'womans_clothes',
+  'womans_hat',
+  'womens',
+  'worried',
+  'wrench',
+  'x',
+  'yellow_heart',
+  'yen',
+  'yum',
+  'zap',
+  'zero',
+  'zzz'
+];
+
+// emoji from All-Github-Emoji-Icons
+// https://github.com/scotch-io/All-Github-Emoji-Icons
+window.emojify = function (match, $1) {
+  return AllGithubEmoji.indexOf($1) === -1
+    ? match
+    : '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' +
+      $1 +
+      '.png" alt="' +
+      $1 +
+      '" />'
+};
+
+}());

lib/plugins/external-script.js

@@ -0,0 +1,30 @@
+(function () {
+'use strict';
+
+function handleExternalScript () {
+  var container = Docsify.dom.getNode('#main');
+  var scripts = Docsify.dom.findAll(container, 'script');
+
+  for (var i = scripts.length; i--;) {
+    var script = scripts[i];
+
+    if (script && script.src) {
+      var newScript = document.createElement('script');
+
+      Array.prototype.slice.call(script.attributes).forEach(function (attribute) {
+        newScript[attribute.name] = attribute.value;
+      });
+
+      script.parentNode.insertBefore(newScript, script);
+      script.parentNode.removeChild(script);
+    }
+  }
+}
+
+var install = function (hook) {
+  hook.doneEach(handleExternalScript);
+};
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+
+}());

lib/plugins/external-script.min.js

@@ -0,0 +1 @@
+!function(){"use strict";function e(){for(var e=Docsify.dom.getNode("#main"),o=Docsify.dom.findAll(e,"script"),n=o.length;n--;){var i=o[n];if(i&&i.src){var t=document.createElement("script");Array.prototype.slice.call(i.attributes).forEach(function(e){t[e.name]=e.value}),i.parentNode.insertBefore(t,i),i.parentNode.removeChild(i)}}}var o=function(o){o.doneEach(e)};window.$docsify.plugins=[].concat(o,window.$docsify.plugins)}();

lib/plugins/front-matter.js

@@ -0,0 +1,498 @@
+(function () {
+'use strict';
+
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/yaml.js
+ */
+/* eslint-disable */
+/*
+YAML parser for Javascript
+Author: Diogo Costa
+This program is released under the MIT License as follows:
+Copyright (c) 2011 Diogo Costa (costa.h4evr@gmail.com)
+Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+*/
+
+/**
+ * @name YAML
+ * @namespace
+*/
+
+var errors = [];
+var reference_blocks = [];
+var processing_time = 0;
+var regex$1 = {
+    regLevel: new RegExp('^([\\s\\-]+)'),
+    invalidLine: new RegExp('^\\-\\-\\-|^\\.\\.\\.|^\\s*#.*|^\\s*$'),
+    dashesString: new RegExp('^\\s*\\"([^\\"]*)\\"\\s*$'),
+    quotesString: new RegExp("^\\s*\\'([^\\']*)\\'\\s*$"),
+    float: new RegExp('^[+-]?[0-9]+\\.[0-9]+(e[+-]?[0-9]+(\\.[0-9]+)?)?$'),
+    integer: new RegExp('^[+-]?[0-9]+$'),
+    array: new RegExp('\\[\\s*(.*)\\s*\\]'),
+    map: new RegExp('\\{\\s*(.*)\\s*\\}'),
+    key_value: new RegExp('([a-z0-9_-][ a-z0-9_-]*):( .+)', 'i'),
+    single_key_value: new RegExp('^([a-z0-9_-][ a-z0-9_-]*):( .+?)$', 'i'),
+    key: new RegExp('([a-z0-9_-][ a-z0-9_-]+):( .+)?', 'i'),
+    item: new RegExp('^-\\s+'),
+    trim: new RegExp('^\\s+|\\s+$'),
+    comment: new RegExp('([^\\\'\\"#]+([\\\'\\"][^\\\'\\"]*[\\\'\\"])*)*(#.*)?')
+  };
+
+/**
+  * @class A block of lines of a given level.
+  * @param {int} lvl The block's level.
+  * @private
+  */
+function Block(lvl) {
+  return {
+    /* The block's parent */
+    parent: null,
+    /* Number of children */
+    length: 0,
+    /* Block's level */
+    level: lvl,
+    /* Lines of code to process */
+    lines: [],
+    /* Blocks with greater level */
+    children: [],
+    /* Add a block to the children collection */
+    addChild: function(obj) {
+      this.children.push(obj);
+      obj.parent = this;
+      ++this.length;
+    }
+  }
+}
+
+function parser$1(str) {
+  var regLevel = regex$1['regLevel'];
+  var invalidLine = regex$1['invalidLine'];
+  var lines = str.split('\n');
+  var m;
+  var level = 0,
+    curLevel = 0;
+
+  var blocks = [];
+
+  var result = new Block(-1);
+  var currentBlock = new Block(0);
+  result.addChild(currentBlock);
+  var levels = [];
+  var line = '';
+
+  blocks.push(currentBlock);
+  levels.push(level);
+
+  for (var i = 0, len = lines.length; i < len; ++i) {
+    line = lines[i];
+
+    if (line.match(invalidLine)) {
+      continue
+    }
+
+    if ((m = regLevel.exec(line))) {
+      level = m[1].length;
+    } else { level = 0; }
+
+    if (level > curLevel) {
+      var oldBlock = currentBlock;
+      currentBlock = new Block(level);
+      oldBlock.addChild(currentBlock);
+      blocks.push(currentBlock);
+      levels.push(level);
+    } else if (level < curLevel) {
+      var added = false;
+
+      var k = levels.length - 1;
+      for (; k >= 0; --k) {
+        if (levels[k] == level) {
+          currentBlock = new Block(level);
+          blocks.push(currentBlock);
+          levels.push(level);
+          if (blocks[k].parent != null) { blocks[k].parent.addChild(currentBlock); }
+          added = true;
+          break
+        }
+      }
+
+      if (!added) {
+        errors.push('Error: Invalid indentation at line ' + i + ': ' + line);
+        return
+      }
+    }
+
+    currentBlock.lines.push(line.replace(regex$1['trim'], ''));
+    curLevel = level;
+  }
+
+  return result
+}
+
+function processValue(val) {
+  val = val.replace(regex$1['trim'], '');
+  var m = null;
+
+  if (val == 'true') {
+    return true
+  } else if (val == 'false') {
+    return false
+  } else if (val == '.NaN') {
+    return Number.NaN
+  } else if (val == 'null') {
+    return null
+  } else if (val == '.inf') {
+    return Number.POSITIVE_INFINITY
+  } else if (val == '-.inf') {
+    return Number.NEGATIVE_INFINITY
+  } else if ((m = val.match(regex$1['dashesString']))) {
+    return m[1]
+  } else if ((m = val.match(regex$1['quotesString']))) {
+    return m[1]
+  } else if ((m = val.match(regex$1['float']))) {
+    return parseFloat(m[0])
+  } else if ((m = val.match(regex$1['integer']))) {
+    return parseInt(m[0])
+  } else if (!isNaN((m = Date.parse(val)))) {
+    return new Date(m)
+  } else if ((m = val.match(regex$1['single_key_value']))) {
+    var res = {};
+    res[m[1]] = processValue(m[2]);
+    return res
+  } else if ((m = val.match(regex$1['array']))) {
+    var count = 0,
+      c = ' ';
+    var res = [];
+    var content = '';
+    var str = false;
+    for (var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+      c = m[1][j];
+      if (c == "'" || c == '"') {
+        if (str === false) {
+          str = c;
+          content += c;
+          continue
+        } else if ((c == "'" && str == "'") || (c == '"' && str == '"')) {
+          str = false;
+          content += c;
+          continue
+        }
+      } else if (str === false && (c == '[' || c == '{')) {
+        ++count;
+      } else if (str === false && (c == ']' || c == '}')) {
+        --count;
+      } else if (str === false && count == 0 && c == ',') {
+        res.push(processValue(content));
+        content = '';
+        continue
+      }
+
+      content += c;
+    }
+
+    if (content.length > 0) { res.push(processValue(content)); }
+    return res
+  } else if ((m = val.match(regex$1['map']))) {
+    var count = 0,
+      c = ' ';
+    var res = [];
+    var content = '';
+    var str = false;
+    for (var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+      c = m[1][j];
+      if (c == "'" || c == '"') {
+        if (str === false) {
+          str = c;
+          content += c;
+          continue
+        } else if ((c == "'" && str == "'") || (c == '"' && str == '"')) {
+          str = false;
+          content += c;
+          continue
+        }
+      } else if (str === false && (c == '[' || c == '{')) {
+        ++count;
+      } else if (str === false && (c == ']' || c == '}')) {
+        --count;
+      } else if (str === false && count == 0 && c == ',') {
+        res.push(content);
+        content = '';
+        continue
+      }
+
+      content += c;
+    }
+
+    if (content.length > 0) { res.push(content); }
+
+    var newRes = {};
+    for (var j = 0, lenJ = res.length; j < lenJ; ++j) {
+      if ((m = res[j].match(regex$1['key_value']))) {
+        newRes[m[1]] = processValue(m[2]);
+      }
+    }
+
+    return newRes
+  } else { return val }
+}
+
+function processFoldedBlock(block) {
+  var lines = block.lines;
+  var children = block.children;
+  var str = lines.join(' ');
+  var chunks = [str];
+  for (var i = 0, len = children.length; i < len; ++i) {
+    chunks.push(processFoldedBlock(children[i]));
+  }
+  return chunks.join('\n')
+}
+
+function processLiteralBlock(block) {
+  var lines = block.lines;
+  var children = block.children;
+  var str = lines.join('\n');
+  for (var i = 0, len = children.length; i < len; ++i) {
+    str += processLiteralBlock(children[i]);
+  }
+  return str
+}
+
+function processBlock(blocks) {
+  var m = null;
+  var res = {};
+  var lines = null;
+  var children = null;
+  var currentObj = null;
+
+  var level = -1;
+
+  var processedBlocks = [];
+
+  var isMap = true;
+
+  for (var j = 0, lenJ = blocks.length; j < lenJ; ++j) {
+    if (level != -1 && level != blocks[j].level) { continue }
+
+    processedBlocks.push(j);
+
+    level = blocks[j].level;
+    lines = blocks[j].lines;
+    children = blocks[j].children;
+    currentObj = null;
+
+    for (var i = 0, len = lines.length; i < len; ++i) {
+      var line = lines[i];
+
+      if ((m = line.match(regex$1['key']))) {
+        var key = m[1];
+
+        if (key[0] == '-') {
+          key = key.replace(regex$1['item'], '');
+          if (isMap) {
+            isMap = false;
+            if (typeof res.length === 'undefined') {
+              res = [];
+            }
+          }
+          if (currentObj != null) { res.push(currentObj); }
+          currentObj = {};
+          isMap = true;
+        }
+
+        if (typeof m[2] != 'undefined') {
+          var value = m[2].replace(regex$1['trim'], '');
+          if (value[0] == '&') {
+            var nb = processBlock(children);
+            if (currentObj != null) { currentObj[key] = nb; }
+            else { res[key] = nb; }
+            reference_blocks[value.substr(1)] = nb;
+          } else if (value[0] == '|') {
+            if (currentObj != null)
+              { currentObj[key] = processLiteralBlock(children.shift()); }
+            else { res[key] = processLiteralBlock(children.shift()); }
+          } else if (value[0] == '*') {
+            var v = value.substr(1);
+            var no = {};
+
+            if (typeof reference_blocks[v] == 'undefined') {
+              errors.push("Reference '" + v + "' not found!");
+            } else {
+              for (var k in reference_blocks[v]) {
+                no[k] = reference_blocks[v][k];
+              }
+
+              if (currentObj != null) { currentObj[key] = no; }
+              else { res[key] = no; }
+            }
+          } else if (value[0] == '>') {
+            if (currentObj != null)
+              { currentObj[key] = processFoldedBlock(children.shift()); }
+            else { res[key] = processFoldedBlock(children.shift()); }
+          } else {
+            if (currentObj != null) { currentObj[key] = processValue(value); }
+            else { res[key] = processValue(value); }
+          }
+        } else {
+          if (currentObj != null) { currentObj[key] = processBlock(children); }
+          else { res[key] = processBlock(children); }
+        }
+      } else if (line.match(/^-\s*$/)) {
+        if (isMap) {
+          isMap = false;
+          if (typeof res.length === 'undefined') {
+            res = [];
+          }
+        }
+        if (currentObj != null) { res.push(currentObj); }
+        currentObj = {};
+        isMap = true;
+        continue
+      } else if ((m = line.match(/^-\s*(.*)/))) {
+        if (currentObj != null) { currentObj.push(processValue(m[1])); }
+        else {
+          if (isMap) {
+            isMap = false;
+            if (typeof res.length === 'undefined') {
+              res = [];
+            }
+          }
+          res.push(processValue(m[1]));
+        }
+        continue
+      }
+    }
+
+    if (currentObj != null) {
+      if (isMap) {
+        isMap = false;
+        if (typeof res.length === 'undefined') {
+          res = [];
+        }
+      }
+      res.push(currentObj);
+    }
+  }
+
+  for (var j = processedBlocks.length - 1; j >= 0; --j) {
+    blocks.splice.call(blocks, processedBlocks[j], 1);
+  }
+
+  return res
+}
+
+function semanticAnalysis(blocks) {
+  var res = processBlock(blocks.children);
+  return res
+}
+
+function preProcess(src) {
+  var m;
+  var lines = src.split('\n');
+
+  var r = regex$1['comment'];
+
+  for (var i in lines) {
+    if ((m = lines[i].match(r))) {
+      /*                var cmt = "";
+            if(typeof m[3] != "undefined")
+                lines[i] = m[1];
+            else if(typeof m[3] != "undefined")
+                lines[i] = m[3];
+            else
+                lines[i] = "";
+                */
+      if (typeof m[3] !== 'undefined') {
+        lines[i] = m[0].substr(0, m[0].length - m[3].length);
+      }
+    }
+  }
+
+  return lines.join('\n')
+}
+
+function load(str) {
+  errors = [];
+  reference_blocks = [];
+  processing_time = new Date().getTime();
+  var pre = preProcess(str);
+  var doc = parser$1(pre);
+  var res = semanticAnalysis(doc);
+  processing_time = new Date().getTime() - processing_time;
+
+  return res
+}
+
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/front-matter.js
+ */
+/* eslint-disable */
+var optionalByteOrderMark = '\\ufeff?';
+var pattern =
+  '^(' +
+  optionalByteOrderMark +
+  '(= yaml =|---)' +
+  '$([\\s\\S]*?)' +
+  '(?:\\2|\\.\\.\\.)' +
+  '$' +
+  '' +
+  '(?:\\n)?)';
+// NOTE: If this pattern uses the 'g' flag the `regex` variable definition will
+// need to be moved down into the functions that use it.
+var regex = new RegExp(pattern, 'm');
+
+function extractor(string) {
+  string = string || '';
+
+  var lines = string.split(/(\r?\n)/);
+  if (lines[0] && /= yaml =|---/.test(lines[0])) {
+    return parse(string)
+  } else {
+    return { attributes: {}, body: string }
+  }
+}
+
+function parse(string) {
+  var match = regex.exec(string);
+
+  if (!match) {
+    return {
+      attributes: {},
+      body: string
+    }
+  }
+
+  var yaml = match[match.length - 1].replace(/^\s+|\s+$/g, '');
+  var attributes = load(yaml) || {};
+  var body = string.replace(match[0], '');
+
+  return { attributes: attributes, body: body, frontmatter: yaml }
+}
+
+var install = function (hook, vm) {
+  hook.beforeEach(function (content) {
+    var ref = extractor(content);
+    var attributes = ref.attributes;
+    var body = ref.body;
+
+    Docsify.util.merge(vm.config, attributes.config);
+
+    return body
+  });
+};
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/ga.js

@@ -0,0 +1,43 @@
+(function () {
+'use strict';
+
+// From https://github.com/egoist/vue-ga/blob/master/src/index.js
+function appendScript () {
+  var script = document.createElement('script');
+  script.async = true;
+  script.src = 'https://www.google-analytics.com/analytics.js';
+  document.body.appendChild(script);
+}
+
+function init (id) {
+  appendScript();
+  window.ga =
+    window.ga ||
+    function () {
+      (window.ga.q = window.ga.q || []).push(arguments);
+    };
+  window.ga.l = Number(new Date());
+  window.ga('create', id, 'auto');
+}
+
+function collect () {
+  if (!window.ga) {
+    init($docsify.ga);
+  }
+
+  window.ga('set', 'page', location.hash);
+  window.ga('send', 'pageview');
+}
+
+var install = function (hook) {
+  if (!$docsify.ga) {
+    console.error('[Docsify] ga is required.');
+    return
+  }
+
+  hook.beforeEach(collect);
+};
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/ga.min.js

@@ -0,0 +1 @@
+!function(){"use strict";function n(){var n=document.createElement("script");n.async=!0,n.src="https://www.google-analytics.com/analytics.js",document.body.appendChild(n)}function o(o){n(),window.ga=window.ga||function(){(window.ga.q=window.ga.q||[]).push(arguments)},window.ga.l=Number(new Date),window.ga("create",o,"auto")}function i(){window.ga||o($docsify.ga),window.ga("set","page",location.hash),window.ga("send","pageview")}var a=function(n){if(!$docsify.ga)return void console.error("[Docsify] ga is required.");n.beforeEach(i)};$docsify.plugins=[].concat(a,$docsify.plugins)}();

lib/plugins/search.js

@@ -0,0 +1,300 @@
+(function () {
+'use strict';
+
+var INDEXS = {};
+var helper;
+
+function escapeHtml (string) {
+  var entityMap = {
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    '\'': '&#39;',
+    '/': '&#x2F;'
+  };
+
+  return String(string).replace(/[&<>"'\/]/g, function (s) { return entityMap[s]; })
+}
+
+function getAllPaths (router) {
+  var paths = [];
+
+  helper.dom.findAll('a:not([data-nosearch])')
+    .map(function (node) {
+      var href = node.href;
+      var originHref = node.getAttribute('href');
+      var path = router.parse(href).path;
+
+      if (path &&
+        paths.indexOf(path) === -1 &&
+        !Docsify.util.isAbsolutePath(originHref)) {
+        paths.push(path);
+      }
+    });
+
+  return paths
+}
+
+function saveData (maxAge) {
+  localStorage.setItem('docsify.search.expires', Date.now() + maxAge);
+  localStorage.setItem('docsify.search.index', JSON.stringify(INDEXS));
+}
+
+function genIndex (path, content, router, depth) {
+  if ( content === void 0 ) content = '';
+
+  var tokens = window.marked.lexer(content);
+  var slugify = window.Docsify.slugify;
+  var index = {};
+  var slug;
+
+  tokens.forEach(function (token) {
+    if (token.type === 'heading' && token.depth <= depth) {
+      slug = router.toURL(path, { id: slugify(token.text) });
+      index[slug] = { slug: slug, title: token.text, body: '' };
+    } else {
+      if (!slug) { return }
+      if (!index[slug]) {
+        index[slug] = { slug: slug, title: '', body: '' };
+      } else {
+        if (index[slug].body) {
+          index[slug].body += '\n' + (token.text || '');
+        } else {
+          index[slug].body = token.text;
+        }
+      }
+    }
+  });
+  slugify.clear();
+  return index
+}
+
+function search (keywords) {
+  var matchingResults = [];
+  var data = [];
+  Object.keys(INDEXS).forEach(function (key) {
+    data = data.concat(Object.keys(INDEXS[key]).map(function (page) { return INDEXS[key][page]; }));
+  });
+
+  keywords = [].concat(keywords, keywords.trim().split(/[\s\-\，\\/]+/));
+
+  var loop = function ( i ) {
+    var post = data[i];
+    var isMatch = false;
+    var resultStr = '';
+    var postTitle = post.title && post.title.trim();
+    var postContent = post.body && post.body.trim();
+    var postUrl = post.slug || '';
+
+    if (postTitle && postContent) {
+      keywords.forEach(function (keyword, i) {
+        var regEx = new RegExp(keyword, 'gi');
+        var indexTitle = -1;
+        var indexContent = -1;
+
+        indexTitle = postTitle && postTitle.search(regEx);
+        indexContent = postContent && postContent.search(regEx);
+
+        if (indexTitle < 0 && indexContent < 0) {
+          isMatch = false;
+        } else {
+          isMatch = true;
+          if (indexContent < 0) { indexContent = 0; }
+
+          var start = 0;
+          var end = 0;
+
+          start = indexContent < 11 ? 0 : indexContent - 10;
+          end = start === 0 ? 70 : indexContent + keyword.length + 60;
+
+          if (end > postContent.length) { end = postContent.length; }
+
+          var matchContent = '...' +
+            escapeHtml(postContent)
+              .substring(start, end)
+              .replace(regEx, ("<em class=\"search-keyword\">" + keyword + "</em>")) +
+              '...';
+
+          resultStr += matchContent;
+        }
+      });
+
+      if (isMatch) {
+        var matchingPost = {
+          title: escapeHtml(postTitle),
+          content: resultStr,
+          url: postUrl
+        };
+
+        matchingResults.push(matchingPost);
+      }
+    }
+  };
+
+  for (var i = 0; i < data.length; i++) loop( i );
+
+  return matchingResults
+}
+
+function init$1 (config, vm) {
+  helper = Docsify;
+
+  var isAuto = config.paths === 'auto';
+  var isExpired = localStorage.getItem('docsify.search.expires') < Date.now();
+
+  INDEXS = JSON.parse(localStorage.getItem('docsify.search.index'));
+
+  if (isExpired) {
+    INDEXS = {};
+  } else if (!isAuto) {
+    return
+  }
+
+  var paths = isAuto ? getAllPaths(vm.router) : config.paths;
+  var len = paths.length;
+  var count = 0;
+
+  paths.forEach(function (path) {
+    if (INDEXS[path]) { return count++ }
+
+    helper
+      .get(vm.router.getFile(path))
+      .then(function (result) {
+        INDEXS[path] = genIndex(path, result, vm.router, config.depth);
+        len === ++count && saveData(config.maxAge);
+      });
+  });
+}
+
+var NO_DATA_TEXT = '';
+
+function style () {
+  var code = "\n.sidebar {\n  padding-top: 0;\n}\n\n.search {\n  margin-bottom: 20px;\n  padding: 6px;\n  border-bottom: 1px solid #eee;\n}\n\n.search .results-panel {\n  display: none;\n}\n\n.search .results-panel.show {\n  display: block;\n}\n\n.search input {\n  outline: none;\n  border: none;\n  width: 100%;\n  padding: 7px;\n  line-height: 22px;\n  font-size: 14px;\n  -webkit-appearance: none;\n  -moz-appearance: none;\n  appearance: none;\n}\n\n.search h2 {\n  font-size: 17px;\n  margin: 10px 0;\n}\n\n.search a {\n  text-decoration: none;\n  color: inherit;\n}\n\n.search .matching-post {\n  border-bottom: 1px solid #eee;\n}\n\n.search .matching-post:last-child {\n  border-bottom: 0;\n}\n\n.search p {\n  font-size: 14px;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  -webkit-line-clamp: 2;\n  -webkit-box-orient: vertical;\n}\n\n.search p.empty {\n  text-align: center;\n}";
+
+  Docsify.dom.style(code);
+}
+
+function tpl (opts, defaultValue) {
+  if ( defaultValue === void 0 ) defaultValue = '';
+
+  var html =
+    "<input type=\"search\" value=\"" + defaultValue + "\" />" +
+    '<div class="results-panel"></div>' +
+    '</div>';
+  var el = Docsify.dom.create('div', html);
+  var aside = Docsify.dom.find('aside');
+
+  Docsify.dom.toggleClass(el, 'search');
+  Docsify.dom.before(aside, el);
+}
+
+function doSearch (value) {
+  var $search = Docsify.dom.find('div.search');
+  var $panel = Docsify.dom.find($search, '.results-panel');
+
+  if (!value) {
+    $panel.classList.remove('show');
+    $panel.innerHTML = '';
+    return
+  }
+  var matchs = search(value);
+
+  var html = '';
+  matchs.forEach(function (post) {
+    html += "<div class=\"matching-post\">\n<h2><a href=\"" + (post.url) + "\">" + (post.title) + "</a></h2>\n<p>" + (post.content) + "</p>\n</div>";
+  });
+
+  $panel.classList.add('show');
+  $panel.innerHTML = html || ("<p class=\"empty\">" + NO_DATA_TEXT + "</p>");
+}
+
+function bindEvents () {
+  var $search = Docsify.dom.find('div.search');
+  var $input = Docsify.dom.find($search, 'input');
+
+  var timeId;
+  // Prevent to Fold sidebar
+  Docsify.dom.on(
+    $search,
+    'click',
+    function (e) { return e.target.tagName !== 'A' && e.stopPropagation(); }
+  );
+  Docsify.dom.on($input, 'input', function (e) {
+    clearTimeout(timeId);
+    timeId = setTimeout(function (_) { return doSearch(e.target.value.trim()); }, 100);
+  });
+}
+
+function updatePlaceholder (text, path) {
+  var $input = Docsify.dom.getNode('.search input[type="search"]');
+
+  if (!$input) { return }
+  if (typeof text === 'string') {
+    $input.placeholder = text;
+  } else {
+    var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
+    $input.placeholder = text[match];
+  }
+}
+
+function updateNoData (text, path) {
+  if (typeof text === 'string') {
+    NO_DATA_TEXT = text;
+  } else {
+    var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
+    NO_DATA_TEXT = text[match];
+  }
+}
+
+function init$$1 (opts, vm) {
+  var keywords = vm.router.parse().query.s;
+
+  style();
+  tpl(opts, keywords);
+  bindEvents();
+  keywords && setTimeout(function (_) { return doSearch(keywords); }, 500);
+}
+
+function update (opts, vm) {
+  updatePlaceholder(opts.placeholder, vm.route.path);
+  updateNoData(opts.noData, vm.route.path);
+}
+
+var CONFIG = {
+  placeholder: 'Type to search',
+  noData: 'No Results!',
+  paths: 'auto',
+  depth: 2,
+  maxAge: 86400000 // 1 day
+};
+
+var install = function (hook, vm) {
+  var util = Docsify.util;
+  var opts = vm.config.search || CONFIG;
+
+  if (Array.isArray(opts)) {
+    CONFIG.paths = opts;
+  } else if (typeof opts === 'object') {
+    CONFIG.paths = Array.isArray(opts.paths) ? opts.paths : 'auto';
+    CONFIG.maxAge = util.isPrimitive(opts.maxAge) ? opts.maxAge : CONFIG.maxAge;
+    CONFIG.placeholder = opts.placeholder || CONFIG.placeholder;
+    CONFIG.noData = opts.noData || CONFIG.noData;
+    CONFIG.depth = opts.depth || CONFIG.depth;
+  }
+
+  var isAuto = CONFIG.paths === 'auto';
+
+  hook.mounted(function (_) {
+    init$$1(CONFIG, vm);
+    !isAuto && init$1(CONFIG, vm);
+  });
+  hook.doneEach(function (_) {
+    update(CONFIG, vm);
+    isAuto && init$1(CONFIG, vm);
+  });
+};
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/search.min.js

@@ -0,0 +1 @@
+!function(){"use strict";function e(e){var n={"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;","/":"&#x2F;"};return String(e).replace(/[&<>"'\/]/g,function(e){return n[e]})}function n(e){var n=[];return h.dom.findAll("a:not([data-nosearch])").map(function(t){var o=t.href,i=t.getAttribute("href"),r=e.parse(o).path;r&&-1===n.indexOf(r)&&!Docsify.util.isAbsolutePath(i)&&n.push(r)}),n}function t(e){localStorage.setItem("docsify.search.expires",Date.now()+e),localStorage.setItem("docsify.search.index",JSON.stringify(g))}function o(e,n,t,o){void 0===n&&(n="");var i,r=window.marked.lexer(n),a=window.Docsify.slugify,s={};return r.forEach(function(n){if("heading"===n.type&&n.depth<=o)i=t.toURL(e,{id:a(n.text)}),s[i]={slug:i,title:n.text,body:""};else{if(!i)return;s[i]?s[i].body?s[i].body+="\n"+(n.text||""):s[i].body=n.text:s[i]={slug:i,title:"",body:""}}}),a.clear(),s}function i(n){var t=[],o=[];Object.keys(g).forEach(function(e){o=o.concat(Object.keys(g[e]).map(function(n){return g[e][n]}))}),n=[].concat(n,n.trim().split(/[\s\-\，\\\/]+/));for(var i=0;i<o.length;i++)!function(i){var r=o[i],a=!1,s="",c=r.title&&r.title.trim(),l=r.body&&r.body.trim(),f=r.slug||"";if(c&&l&&(n.forEach(function(n,t){var o=new RegExp(n,"gi"),i=-1,r=-1;if(i=c&&c.search(o),r=l&&l.search(o),i<0&&r<0)a=!1;else{a=!0,r<0&&(r=0);var f=0,d=0;f=r<11?0:r-10,d=0===f?70:r+n.length+60,d>l.length&&(d=l.length);var p="..."+e(l).substring(f,d).replace(o,'<em class="search-keyword">'+n+"</em>")+"...";s+=p}}),a)){var d={title:e(c),content:s,url:f};t.push(d)}}(i);return t}function r(e,i){h=Docsify;var r="auto"===e.paths,a=localStorage.getItem("docsify.search.expires")<Date.now();if(g=JSON.parse(localStorage.getItem("docsify.search.index")),a)g={};else if(!r)return;var s=r?n(i.router):e.paths,c=s.length,l=0;s.forEach(function(n){if(g[n])return l++;h.get(i.router.getFile(n)).then(function(r){g[n]=o(n,r,i.router,e.depth),c===++l&&t(e.maxAge)})})}function a(){Docsify.dom.style("\n.sidebar {\n  padding-top: 0;\n}\n\n.search {\n  margin-bottom: 20px;\n  padding: 6px;\n  border-bottom: 1px solid #eee;\n}\n\n.search .results-panel {\n  display: none;\n}\n\n.search .results-panel.show {\n  display: block;\n}\n\n.search input {\n  outline: none;\n  border: none;\n  width: 100%;\n  padding: 7px;\n  line-height: 22px;\n  font-size: 14px;\n  -webkit-appearance: none;\n  -moz-appearance: none;\n  appearance: none;\n}\n\n.search h2 {\n  font-size: 17px;\n  margin: 10px 0;\n}\n\n.search a {\n  text-decoration: none;\n  color: inherit;\n}\n\n.search .matching-post {\n  border-bottom: 1px solid #eee;\n}\n\n.search .matching-post:last-child {\n  border-bottom: 0;\n}\n\n.search p {\n  font-size: 14px;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  -webkit-line-clamp: 2;\n  -webkit-box-orient: vertical;\n}\n\n.search p.empty {\n  text-align: center;\n}")}function s(e,n){void 0===n&&(n="");var t='<input type="search" value="'+n+'" /><div class="results-panel"></div></div>',o=Docsify.dom.create("div",t),i=Docsify.dom.find("aside");Docsify.dom.toggleClass(o,"search"),Docsify.dom.before(i,o)}function c(e){var n=Docsify.dom.find("div.search"),t=Docsify.dom.find(n,".results-panel");if(!e)return t.classList.remove("show"),void(t.innerHTML="");var o=i(e),r="";o.forEach(function(e){r+='<div class="matching-post">\n<h2><a href="'+e.url+'">'+e.title+"</a></h2>\n<p>"+e.content+"</p>\n</div>"}),t.classList.add("show"),t.innerHTML=r||'<p class="empty">'+y+"</p>"}function l(){var e,n=Docsify.dom.find("div.search"),t=Docsify.dom.find(n,"input");Docsify.dom.on(n,"click",function(e){return"A"!==e.target.tagName&&e.stopPropagation()}),Docsify.dom.on(t,"input",function(n){clearTimeout(e),e=setTimeout(function(e){return c(n.target.value.trim())},100)})}function f(e,n){var t=Docsify.dom.getNode('.search input[type="search"]');if(t)if("string"==typeof e)t.placeholder=e;else{var o=Object.keys(e).filter(function(e){return n.indexOf(e)>-1})[0];t.placeholder=e[o]}}function d(e,n){if("string"==typeof e)y=e;else{var t=Object.keys(e).filter(function(e){return n.indexOf(e)>-1})[0];y=e[t]}}function p(e,n){var t=n.router.parse().query.s;a(),s(e,t),l(),t&&setTimeout(function(e){return c(t)},500)}function u(e,n){f(e.placeholder,n.route.path),d(e.noData,n.route.path)}var h,g={},y="",m={placeholder:"Type to search",noData:"No Results!",paths:"auto",depth:2,maxAge:864e5},v=function(e,n){var t=Docsify.util,o=n.config.search||m;Array.isArray(o)?m.paths=o:"object"==typeof o&&(m.paths=Array.isArray(o.paths)?o.paths:"auto",m.maxAge=t.isPrimitive(o.maxAge)?o.maxAge:m.maxAge,m.placeholder=o.placeholder||m.placeholder,m.noData=o.noData||m.noData,m.depth=o.depth||m.depth);var i="auto"===m.paths;e.mounted(function(e){p(m,n),!i&&r(m,n)}),e.doneEach(function(e){u(m,n),i&&r(m,n)})};$docsify.plugins=[].concat(v,$docsify.plugins)}();

lib/plugins/zoom-image.js

@@ -0,0 +1,303 @@
+(function () {
+'use strict';
+
+var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
+
+
+
+
+
+function createCommonjsModule(fn, module) {
+	return module = { exports: {} }, fn(module, module.exports), module.exports;
+}
+
+var zoomImage = createCommonjsModule(function (module, exports) {
+(function (global, factory) {
+  module.exports = factory();
+}(commonjsGlobal, (function () { 'use strict';
+
+var windowWidth = function () { return document.documentElement.clientWidth; };
+var windowHeight = function () { return document.documentElement.clientHeight; };
+
+var elemOffset = function (elem) {
+  var rect = elem.getBoundingClientRect();
+  var docElem = document.documentElement;
+  var win = window;
+  return {
+    top: rect.top + win.pageYOffset - docElem.clientTop,
+    left: rect.left + win.pageXOffset - docElem.clientLeft
+  }
+};
+
+var once = function (elem, type, handler) {
+  var fn = function (e) {
+    e.target.removeEventListener(type, fn);
+    handler();
+  };
+  elem.addEventListener(type, fn);
+};
+
+var Size = function Size(w, h) {
+  this.w = w;
+  this.h = h;
+};
+
+var ZoomImage = function ZoomImage(img, offset) {
+  this.img = img;
+  this.preservedTransform = img.style.transform;
+  this.wrap = null;
+  this.overlay = null;
+  this.offset = offset;
+};
+
+ZoomImage.prototype.forceRepaint = function forceRepaint () {
+  var _ = this.img.offsetWidth;
+  return
+};
+
+ZoomImage.prototype.zoom = function zoom () {
+  var size = new Size(this.img.naturalWidth, this.img.naturalHeight);
+
+  this.wrap = document.createElement('div');
+  this.wrap.classList.add('zoom-img-wrap');
+  this.img.parentNode.insertBefore(this.wrap, this.img);
+  this.wrap.appendChild(this.img);
+
+  this.img.classList.add('zoom-img');
+  this.img.setAttribute('data-action', 'zoom-out');
+
+  this.overlay = document.createElement('div');
+  this.overlay.classList.add('zoom-overlay');
+  document.body.appendChild(this.overlay);
+
+  this.forceRepaint();
+  var scale = this.calculateScale(size);
+
+  this.forceRepaint();
+  this.animate(scale);
+
+  document.body.classList.add('zoom-overlay-open');
+};
+
+ZoomImage.prototype.calculateScale = function calculateScale (size) {
+  var maxScaleFactor = size.w / this.img.width;
+
+  var viewportWidth = (windowWidth() - this.offset);
+  var viewportHeight = (windowHeight() - this.offset);
+  var imageAspectRatio = size.w / size.h;
+  var viewportAspectRatio = viewportWidth / viewportHeight;
+
+  if (size.w < viewportWidth && size.h < viewportHeight) {
+    return maxScaleFactor
+  } else if (imageAspectRatio < viewportAspectRatio) {
+    return (viewportHeight / size.h) * maxScaleFactor
+  }
+  return (viewportWidth / size.w) * maxScaleFactor
+};
+
+ZoomImage.prototype.animate = function animate (scale) {
+  var imageOffset = elemOffset(this.img);
+  var scrollTop = window.pageYOffset;
+
+  var viewportX = (windowWidth() / 2);
+  var viewportY = scrollTop + (windowHeight() / 2);
+
+  var imageCenterX = imageOffset.left + (this.img.width / 2);
+  var imageCenterY = imageOffset.top + (this.img.height / 2);
+
+  var tx = viewportX - imageCenterX;
+  var ty = viewportY - imageCenterY;
+  var tz = 0;
+
+  var imgTr = "scale(" + scale + ")";
+  var wrapTr = "translate3d(" + tx + "px, " + ty + "px, " + tz + "px)";
+
+  this.img.style.transform = imgTr;
+  this.wrap.style.transform = wrapTr;
+};
+
+ZoomImage.prototype.dispose = function dispose () {
+  if (this.wrap === null || this.wrap.parentNode === null) {
+    return
+  }
+  this.img.classList.remove('zoom-img');
+  this.img.setAttribute('data-action', 'zoom');
+
+  this.wrap.parentNode.insertBefore(this.img, this.wrap);
+  this.wrap.parentNode.removeChild(this.wrap);
+
+  document.body.removeChild(this.overlay);
+  document.body.classList.remove('zoom-overlay-transitioning');
+};
+
+ZoomImage.prototype.close = function close () {
+    var this$1 = this;
+
+  document.body.classList.add('zoom-overlay-transitioning');
+  this.img.style.transform = this.preservedTransform;
+  if (this.img.style.length === 0) {
+    this.img.removeAttribute('style');
+  }
+  this.wrap.style.transform = 'none';
+
+  once(this.img, 'transitionend', function () {
+    this$1.dispose();
+    // remove class should happen after dispose. Otherwise,
+    // a new click event could fire and create a duplicate ZoomImage for
+    // the same <img> element.
+    document.body.classList.remove('zoom-overlay-open');
+  });
+};
+
+/**
+ * Pure JavaScript implementation of zoom.js.
+ *
+ * Original preamble:
+ * zoom.js - It's the best way to zoom an image
+ * @version v0.0.2
+ * @link https://github.com/fat/zoom.js
+ * @license MIT
+ *
+ * Needs a related CSS file to work. See the README at
+ * https://github.com/nishanths/zoom.js for more info.
+ *
+ * This is a fork of the original zoom.js implementation by @fat.
+ * Copyrights for the original project are held by @fat. All other copyright
+ * for changes in the fork are held by Nishanth Shanmugham.
+ *
+ * Copyright (c) 2013 @fat
+ * The MIT License. Copyright © 2016 Nishanth Shanmugham.
+ */
+
+var current = null;
+var offset = 80;
+var initialScrollPos = -1;
+var initialTouchPos = -1;
+
+function handleScroll() {
+  if (initialScrollPos === -1) {
+    initialScrollPos = window.pageYOffset;
+  }
+
+  var deltaY = Math.abs(initialScrollPos - window.pageYOffset);
+  if (deltaY >= 40) {
+    closeCurrent();
+  }
+}
+
+function handleKeyup(e) {
+  if (e.keyCode === 27) {
+    closeCurrent();
+  }
+}
+
+function handleTouchStart(e) {
+  var t = e.touches[0];
+  if (t === null) {
+    return
+  }
+
+  initialTouchPos = t.pageY;
+  e.target.addEventListener('touchmove', handleTouchMove);
+}
+
+function handleTouchMove(e) {
+  var t = e.touches[0];
+  if (t === null) {
+    return
+  }
+
+  if (Math.abs(t.pageY - initialTouchPos) > 10) {
+    closeCurrent();
+    e.target.removeEventListener('touchmove', handleTouchMove);
+  }
+}
+
+function handleClick() {
+  closeCurrent();
+}
+
+function addCloseListeners() {
+  document.addEventListener('scroll', handleScroll);
+  document.addEventListener('keyup', handleKeyup);
+  document.addEventListener('touchstart', handleTouchStart);
+  document.addEventListener('click', handleClick, true);
+}
+
+function removeCloseListeners() {
+  document.removeEventListener('scroll', handleScroll);
+  document.removeEventListener('keyup', handleKeyup);
+  document.removeEventListener('touchstart', handleTouchStart);
+  document.removeEventListener('click', handleClick, true);
+}
+
+function closeCurrent(force) {
+  if (current === null) {
+    return
+  }
+  if (force) {
+    current.dispose();
+  } else {
+    current.close();
+  }
+  removeCloseListeners();
+  current = null;
+}
+
+function prepareZoom(e) {
+  if (document.body.classList.contains('zoom-overlay-open')) {
+    return
+  }
+
+  if (e.metaKey || e.ctrlKey) {
+    window.open((e.target.getAttribute('data-original') || e.target.src), '_blank');
+    return
+  }
+
+  if (e.target.width >= windowWidth() - offset) {
+    return
+  }
+
+  closeCurrent(true);
+
+  current = new ZoomImage(e.target, offset);
+  current.zoom();
+
+  addCloseListeners();
+}
+
+var zoom = function (el) {
+  el.setAttribute('data-action', 'zoom');
+  el.addEventListener('click', prepareZoom);
+  return function () { return el.removeEventListener('click', prepareZoom); }
+};
+
+return zoom;
+
+})));
+});
+
+var style = "img[data-action=\"zoom\"] {\n  cursor: pointer;\n  cursor: -webkit-zoom-in;\n  cursor: zoom-in;\n}\n.zoom-img,\n.zoom-img-wrap {\n  position: relative;\n  z-index: 666;\n  transition: -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1), -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n}\n.zoom-overlay {\n  z-index: 420;\n  background: #fff;\n  position: fixed;\n  top: 0;\n  left: 0;\n  right: 0;\n  bottom: 0;\n  pointer-events: none;\n  opacity: 0;\n  transition: opacity 300ms;\n}\n.zoom-overlay-open .zoom-overlay {\n  opacity: 1;\n}\n.zoom-overlay-open {\n  cursor: pointer;\n  cursor: -webkit-zoom-out;\n  cursor: zoom-out;\n}\n.zoom-overlay-transitioning {\n  cursor: default;\n}\n.zoom-overlay-open.zoom-overlay-transitioning .zoom-overlay{\n  opacity: 0;\n}\n";
+
+function install (hook) {
+  var dom = Docsify.dom;
+  var destroys;
+
+  // add style
+  dom.appendTo(dom.head, dom.create('style', style));
+
+  hook.doneEach(function (_) {
+    var images = dom.findAll('img:not(.emoji)');
+
+    if (Array.isArray(destroys) && destroys.length) {
+      destroys.forEach(function (o) { return o(); });
+      destroys = [];
+    }
+
+    destroys = images.map(zoomImage);
+  });
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/zoom-image.min.js

@@ -0,0 +1 @@
+!function(){"use strict";function t(t){var o,i=Docsify.dom;i.appendTo(i.head,i.create("style",n)),t.doneEach(function(t){var n=i.findAll("img:not(.emoji)");Array.isArray(o)&&o.length&&(o.forEach(function(t){return t()}),o=[]),o=n.map(e)})}var e=("undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self&&self,function(t,e){return e={exports:{}},t(e,e.exports),e.exports}(function(t,e){!function(e,n){t.exports=function(){function t(){-1===g&&(g=window.pageYOffset),Math.abs(g-window.pageYOffset)>=40&&a()}function e(t){27===t.keyCode&&a()}function n(t){var e=t.touches[0];null!==e&&(y=e.pageY,t.target.addEventListener("touchmove",o))}function o(t){var e=t.touches[0];null!==e&&Math.abs(e.pageY-y)>10&&(a(),t.target.removeEventListener("touchmove",o))}function i(){a()}function r(){document.addEventListener("scroll",t),document.addEventListener("keyup",e),document.addEventListener("touchstart",n),document.addEventListener("click",i,!0)}function s(){document.removeEventListener("scroll",t),document.removeEventListener("keyup",e),document.removeEventListener("touchstart",n),document.removeEventListener("click",i,!0)}function a(t){null!==h&&(t?h.dispose():h.close(),s(),h=null)}function c(t){if(!document.body.classList.contains("zoom-overlay-open"))return t.metaKey||t.ctrlKey?void window.open(t.target.getAttribute("data-original")||t.target.src,"_blank"):void(t.target.width>=m()-v||(a(!0),h=new p(t.target,v),h.zoom(),r()))}var m=function(){return document.documentElement.clientWidth},u=function(){return document.documentElement.clientHeight},d=function(t){var e=t.getBoundingClientRect(),n=document.documentElement,o=window;return{top:e.top+o.pageYOffset-n.clientTop,left:e.left+o.pageXOffset-n.clientLeft}},l=function(t,e,n){var o=function(t){t.target.removeEventListener(e,o),n()};t.addEventListener(e,o)},f=function(t,e){this.w=t,this.h=e},p=function(t,e){this.img=t,this.preservedTransform=t.style.transform,this.wrap=null,this.overlay=null,this.offset=e};p.prototype.forceRepaint=function(){this.img.offsetWidth},p.prototype.zoom=function(){var t=new f(this.img.naturalWidth,this.img.naturalHeight);this.wrap=document.createElement("div"),this.wrap.classList.add("zoom-img-wrap"),this.img.parentNode.insertBefore(this.wrap,this.img),this.wrap.appendChild(this.img),this.img.classList.add("zoom-img"),this.img.setAttribute("data-action","zoom-out"),this.overlay=document.createElement("div"),this.overlay.classList.add("zoom-overlay"),document.body.appendChild(this.overlay),this.forceRepaint();var e=this.calculateScale(t);this.forceRepaint(),this.animate(e),document.body.classList.add("zoom-overlay-open")},p.prototype.calculateScale=function(t){var e=t.w/this.img.width,n=m()-this.offset,o=u()-this.offset,i=t.w/t.h,r=n/o;return t.w<n&&t.h<o?e:i<r?o/t.h*e:n/t.w*e},p.prototype.animate=function(t){var e=d(this.img),n=window.pageYOffset,o=m()/2,i=n+u()/2,r=e.left+this.img.width/2,s=e.top+this.img.height/2,a=o-r,c=i-s,l="scale("+t+")",f="translate3d("+a+"px, "+c+"px, 0px)";this.img.style.transform=l,this.wrap.style.transform=f},p.prototype.dispose=function(){null!==this.wrap&&null!==this.wrap.parentNode&&(this.img.classList.remove("zoom-img"),this.img.setAttribute("data-action","zoom"),this.wrap.parentNode.insertBefore(this.img,this.wrap),this.wrap.parentNode.removeChild(this.wrap),document.body.removeChild(this.overlay),document.body.classList.remove("zoom-overlay-transitioning"))},p.prototype.close=function(){var t=this;document.body.classList.add("zoom-overlay-transitioning"),this.img.style.transform=this.preservedTransform,0===this.img.style.length&&this.img.removeAttribute("style"),this.wrap.style.transform="none",l(this.img,"transitionend",function(){t.dispose(),document.body.classList.remove("zoom-overlay-open")})};var h=null,v=80,g=-1,y=-1;return function(t){return t.setAttribute("data-action","zoom"),t.addEventListener("click",c),function(){return t.removeEventListener("click",c)}}}()}()})),n='img[data-action="zoom"] {\n  cursor: pointer;\n  cursor: -webkit-zoom-in;\n  cursor: zoom-in;\n}\n.zoom-img,\n.zoom-img-wrap {\n  position: relative;\n  z-index: 666;\n  transition: -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1), -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n}\n.zoom-overlay {\n  z-index: 420;\n  background: #fff;\n  position: fixed;\n  top: 0;\n  left: 0;\n  right: 0;\n  bottom: 0;\n  pointer-events: none;\n  opacity: 0;\n  transition: opacity 300ms;\n}\n.zoom-overlay-open .zoom-overlay {\n  opacity: 1;\n}\n.zoom-overlay-open {\n  cursor: pointer;\n  cursor: -webkit-zoom-out;\n  cursor: zoom-out;\n}\n.zoom-overlay-transitioning {\n  cursor: default;\n}\n.zoom-overlay-open.zoom-overlay-transitioning .zoom-overlay{\n  opacity: 0;\n}\n';$docsify.plugins=[].concat(t,$docsify.plugins)}();