[release] 4.0.2 next

* Add newline before appended content

* Also add new line to dev page

.eslintignore

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

.eslintrc

@@ -1,5 +1,10 @@
 {
-  "extends": ["vue"],
+  "extends": [
+    "vue"
+  ],
+  "parserOptions": {
+      "ecmaVersion": 8
+    },
   "env": {
     "browser": 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,4 +1,4 @@
-.DS_Store
 *.log
+.DS_Store
+/themes
 node_modules
-/themes

.npmignore

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

.travis.yml

@@ -1,6 +1,9 @@
 sudo: false
 cache:
   directories:
-  - $HOME/.yarn-cache
+    - $HOME/.yarn-cache
 language: node_js
 node_js: stable
+os:
+  - linux
+  - osx

CHANGELOG.md

@@ -1,72 +1,158 @@
+# Changelog
 
-3.2.0 / 2017-02-28
-==================
+## 3.7.3 / 2017-05-22
 
-  * fix(render): Toc rendering error, fixed #106
-  * feat(search): Localization for no data tip, close #103
-  * fix(fetch): load sidebar and navbar for parent path, fixed #100
-  * feat(render) nameLink for each route, fixed #99
+  * fix(render): find => filter, Compatible with old browser
+  * Pretty dir tree
 
-3.1.2 / 2017-02-27
-==================
+## 3.7.2 / 2017-05-19
 
-  * fix(search): dont search nameLink, fixed #102
+  * tweaks
 
-3.1.1 / 2017-02-24
-==================
+## 3.7.1 / 2017-05-19
 
-  * fix(search): dont search nameLink, fixed #102
-  * fix(render): custom cover background image
-  * fix(tpl): extra character, fixed #101
+  * fix: docsify-updated is undefined
 
-3.1.0 / 2017-02-22
-==================
+## 3.7.0 / 2017-05-16
 
-  * fix(search): incorrect anchor link, fixed #90
-  * feat(emoji): add emoji plugin
+  * feat: add externalLinkTarget, close ([#149](https://github.com/QingWei-Li/docsify/issues/149)
+  * feat: add **{docsify-updated<span>}</span>**, close ([#158](https://github.com/QingWei-Li/docsify/issues/158)
 
-3.0.5 / 2017-02-21
-==================
+## 3.6.6 / 2017-05-06
 
-  * feat(pwa): add sw.js
-  * fix(layout.css): loading style
-  * fix(event): highlight sidebar when clicked, fixed #86
-  * fix(gen-tree): cache toc list, fixed #88
+  * feat: support query string for the search, likes `https://docsify.js.org/#/?s=navbar`, fixed ([#156](https://github.com/QingWei-Li/docsify/issues/156)
 
-3.0.4 / 2017-02-20
-==================
+## 3.6.5 / 2017-04-28
 
-  * fix(render): execute script
-  * fix(render): disable rendering sub list when loadSidebar is false
+  * fix(util): fix crash, fixed ([#154](https://github.com/QingWei-Li/docsify/issues/154)
 
-3.0.3 / 2017-02-19
-==================
+## 3.6.4 / 2017-04-28
 
-  * fixed look of links in blockquote
-  * fix(scroll) highlight bug
+  * fix(util): correctly clean up duplicate slashes, fixed ([#153](https://github.com/QingWei-Li/docsify/issues/153)
 
-3.0.2 / 2017-02-19
-==================
+## 3.6.3 / 2017-04-25
 
-  * fix(search): add lazy input
-  * fix(compiler): link
+  * fix(external-script): script attrs
 
-3.0.1 / 2017-02-19
-==================
+## 3.6.2/ 2017-04-12
 
-  * fix(route): empty alias
+  * feat(external-script): detect more than one script dom, fixed ([#146](https://github.com/QingWei-Li/docsify/issues/146)
+  * GA: Send hash instead of complete href ([#147](https://github.com/QingWei-Li/docsify/issues/147)
 
-3.0.0 / 2017-02-19
-==================
+## 3.6.1 / 2017-04-09
 
-#### Breaking change
-- Not support IE9
-- The route becomes: `/#/page?id=slug`. The previous route will be redirected
+  * feat(event): Collapse the sidebar when click outside element in the small screen
 
-#### Features
-- Faster rendering
-- Clearer source code
-- More powerful API
-- Auto header for each page [#78](https://github.com/QingWei-Li/docsify/issues/78)
-- Localization for search plugin [#80](https://github.com/QingWei-Li/docsify/issues/80)
-- Execute the script in markdown (see `executeScript`)
+## 3.6.0 / 2017-04-09
+
+  * feat(render): add mergeNavbar option, close ([#125](https://github.com/QingWei-Li/docsify/issues/125)
+
+## 3.5.2/ 2017-04-05
+
+  * add optional current route param to toURL and use it to properly compose local anchor links
+  * fix code style by removing semicolons
+  * in toURL test for anchor links and if so prepend the currentPath to the generated path. fixes ([#142](https://github.com/QingWei-Li/docsify/issues/142))
+
+## 3.5.1 / 2017-03-25
+
+  * fix: .md file extension regex
+
+## 3.5.0 / 2017-03-25
+
+  * feat(route): auto remove .md extension
+  * fix: adjust display on small screens [@jrappen](https://github.com/jrappen)
+  * fix: navbar labels for German [@jrappen](https://github.com/jrappen)
+
+## 3.4.4 / 2017-03-17
+
+  * fix(search): fix input style
+  * fix search plugin match bug
+
+## 3.4.3 / 2017-03-16
+
+  * Add ability to ignore headers when generating toc ([#127](https://github.com/QingWei-Li/docsify/issues/127) [@christopherwk210](https://github.com/christopherwk210))
+  * fix external-script not inserting script at right place [@Leopoldthecoder](https://github.com/Leopoldthecoder)
+  * add German docs [@jrappen](https://github.com/jrappen)
+
+## 3.4.2 / 2017-03-11
+
+* feat(emojify): add no-emoji option
+
+## 3.4.1 / 2017-03-10
+
+* fix(dom): Disable the dom cache when vue is present, fixed [#119](https://github.com/QingWei-Li/docsify/issues/119)
+* update english docs, [@jrappen](https://github.com/jrappen)
+
+## 3.4.0 / 2017-03-09
+
+* feat(zoom-image): add plugin
+
+## 3.3.0 / 2017-03-07
+
+* add front-matter plugin
+* add external-script plugin, [@Leopoldthecoder](https://github.com/Leopoldthecoder)
+* Fix nav showing while loading ([#112](https://github.com/QingWei-Li/docsify/issues/112))
+
+## 3.2.0 / 2017-02-28
+
+* fix(render): Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106)
+* feat(search): Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103)
+* fix(fetch): load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100)
+* feat(render) nameLink for each route, fixed [#99](https://github.com/QingWei-Li/docsify/issues/99)
+
+## 3.1.2 / 2017-02-27
+
+* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
+
+## 3.1.1 / 2017-02-24
+
+* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
+* fix(render): custom cover background image
+* fix(tpl): extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101)
+
+## 3.1.0 / 2017-02-22
+
+* fix(search): incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90)
+* feat(emoji): add emoji plugin
+
+## 3.0.5 / 2017-02-21
+
+* feat(pwa): add sw.js
+* fix(layout.css): loading style
+* fix(event): highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86)
+* fix(gen-tree): cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88)
+
+## 3.0.4 / 2017-02-20
+
+* fix(render): execute script
+* fix(render): disable rendering sub list when loadSidebar is false
+
+## 3.0.3 / 2017-02-19
+
+* fixed look of links in blockquote
+* fix(scroll) highlight bug
+
+## 3.0.2 / 2017-02-19
+
+* fix(search): add lazy input
+* fix(compiler): link
+
+## 3.0.1 / 2017-02-19
+
+* fix(route): empty alias
+
+## 3.0.0 / 2017-02-19
+
+##### Breaking change
+
+* Not support IE9
+* The route becomes: `/#/page?id=slug`. The previous route will be redirected
+
+##### Features
+
+* Faster rendering
+* Clearer source code
+* More powerful API
+* Auto header for each page [#78](https://github.com/QingWei-Li/docsify/issues/78)
+* Localization for search plugin [#80](https://github.com/QingWei-Li/docsify/issues/80)
+* Execute the script in markdown (see `executeScript`)

HISTORY.md

@@ -3,22 +3,24 @@
 > 2017-02-15
 
 #### Bug fixes
-* fix emoji replacing error (#76)
+
+* fix emoji replacing error ([#76](https://github.com/QingWei-Li/docsify/issues/76))
 
 ### 2.4.2
 
 > 2017-02-14
 
 #### Bug fixes
-- fix(index): load file path error
 
+* fix(index): load file path error
 
 ### 2.4.1
 
 > 2017-02-13
 
 #### Bug fixes
-- fix(index): cover page
+
+* fix(index): cover page
 
 ### 2.4.0
 
@@ -26,8 +28,7 @@
 
 #### Features
 
-- feat(hook): add `doneEach`
-
+* feat(hook): add `doneEach`
 
 ### 2.3.0
 
@@ -35,352 +36,477 @@
 
 #### Features
 
-- feat(src): add alias feature
-- docs: update all documents
-- feat(src): dynamic title
-- feat(hook): support custom plugin
-- feat(themes): add dark theme
+* feat(src): add alias feature
+* docs: update all documents
+* feat(src): dynamic title
+* feat(hook): support custom plugin
+* feat(themes): add dark theme
 
 #### Bug fixes
-- fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
-- fix: sidebar style
-- fix(render): fix render link
+
+* fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
+* fix: sidebar style
+* fix(render): fix render link
 
 ### 2.2.1
 
 > 2017-02-11
 
 #### Bug fixes
-- fix(search): crash when not content, fixed #68
-- fix(event): scroll active sidebar
-- fix(search): not work in mobile
+
+* fix(search): crash when not content, fixed [#68](https://github.com/QingWei-Li/docsify/issues/68)
+* fix(event): scroll active sidebar
+* fix(search): not work in mobile
 
 ### 2.2.0
 
 #### Features
-- Add `Google Analytics` plugin.
-```html
-<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
-<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
-```
+
+* Add `Google Analytics` plugin.
+  ```html
+  <script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+  ```
 
 ### 2.1.0
+
 #### Features
-- Add search plugin
-```html
-<script src="//unpkg.com/docsify"></script>
-<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
-```
+
+* Add search plugin
+  ```html
+  <script src="//unpkg.com/docsify"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
+  ```
 
 #### Bug fixes
-- fix sidebar style
+
+* fix sidebar style
 
 ### 2.0.3
+
 #### Bug fixes
-- fix: rendering emojis
-- fix: css var polyfill
+
+* fix: rendering emojis
+* fix: css var polyfill
 
 ### 2.0.2
 
 #### Bug fixes
-- fix button style in cover page.
+
+* fix button style in cover page.
 
 ### 2.0.1
+
 #### Bug fixes
-- border style.
+
+* border style.
 
 ### 2.0.0
+
 #### Features
-- Customize the theme color
+
+* Customize the theme color
 
 #### Break change
-- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
+
+* Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
 
 
 ### 1.10.5
+
 #### Bug fixes
-- fix initialize the Vue instance
+
+* fix initialize the Vue instance
 
 ### 1.10.4
+
 #### Bug fixes
-- fix execute script
+
+* fix execute script
 
 ### 1.10.3
+
 #### Bug fixes
-- compatible vuep QingWei-Li/vuep/issues/2
-- fix sidebar scroll, fixed #63
+
+* compatible vuep ([#2](https://github.com/QingWei-Li/vuep/issues/2))
+* fix sidebar scroll, fixed [#63](https://github.com/QingWei-Li/docsify/issues/63)
 
 ### 1.10.2
+
 #### Bug fixes
-- Fix render emojis again
+
+* Fix render emojis again
 
 ### 1.10.1
+
 #### Bug fixes
-- Fix render emojis
+
+* Fix render emojis
 
 ### 1.10.0
+
 #### Features
-- Support emoji :laughing:
+
+* Support emoji :laughing:
 
 ### 1.9.0
 
 #### Bug fixes
-- Destroys the vue instance when the route is changed
+
+* Destroys the vue instance when the route is changed
 
 #### Features
-- Add `!>` and `?>` doc helper.
+
+* Add `!>` and `?>` doc helper.
 
 #### Break change
-- Remove `!` doc helper.
+
+* Remove `!` doc helper.
 
 ### 1.8.0
+
 #### Bug fixes
-- Using `v-pre` skip compilation.
+
+* Using `v-pre` skip compilation.
 
 ### Features
-- Execute script when vue exists.
+
+* Execute script when vue exists.
 
 ### 1.7.4
+
 #### Bug fixes
-- Fix bugs caused by the previous version
+
+* Fix bugs caused by the previous version
 
 ### 1.7.3
+
 #### Bug fixes
-- Add `hr` style
-- Fixed option is an empty string
+
+* Add `hr` style
+* Fixed option is an empty string
 
 ### 1.7.2
+
 #### Bug fixes
-- Fix sidebar click event in mobile browser.
+
+* Fix sidebar click event in mobile browser.
 
 ### 1.7.1
+
 #### Bug fixes
-- Fix sidebar style in mobile browser.
+
+* Fix sidebar style in mobile browser.
 
 ### 1.7.0
 
 #### Bug fixes
-- Fixed custom cover background, fixed #52
-- Fixed sticky sidebar
+
+* Fixed custom cover background, fixed [#52](https://github.com/QingWei-Li/docsify/issues/52)
+* Fixed sticky sidebar
 
 ### Features
-- Add `name` and `nameLink`
+
+* Add `name` and `nameLink`
 
 ### 1.6.1
+
 #### Bug fixes
-- Fixed sidebar bug when the coverpage exist
+
+* Fixed sidebar bug when the coverpage exist
 
 ### 1.6.0
+
 #### Features
-- Improve sidebar performance. The active item is automatically scrolled in the visible view.
-- New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
+
+* Improve sidebar performance. The active item is automatically scrolled in the visible view.
+* New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
 
 ### 1.5.2
+
 #### Bug fixes
-- Fixed number at the beginning of the slug
+
+* Fixed number at the beginning of the slug
 
 ### 1.5.1
+
 #### Bug fixes
-- Remove HTML tag when handling slug
+
+* Remove HTML tag when handling slug
 
 ### 1.5.0
 
 #### Bug fixes
-- Fix slugify.
-- Fix nav highlight.
+
+* Fix slugify.
+* Fix nav highlight.
 
 #### Features
-- Initialize the configuration by `window.$docsify`.
-- Markdown parser is configurable.
+
+* Initialize the configuration by `window.$docsify`.
+* Markdown parser is configurable.
 
 ### 1.4.3
+
 #### Bug fixes
-- Tweak style.
+
+* Tweak style.
 
 ### 1.4.2
 
 #### Bug fixes
-- Fix toggle button style.
-- Support `mailto`, `tel`, etc. href type
-- Fix scroll to top.
 
+* Fix toggle button style.
+* Support `mailto`, `tel`, etc. href type
+* Fix scroll to top.
 
 ### 1.4.1
+
 #### Bug fixes
-- Fix generate slug.
+
+* Fix generate slug.
 
 ### 1.4.0 Happly new year 🎉
+
 #### Features
-- Display TOC in the custom sidebar, `data-sub-max-level`.
-- Custom background in coverpage.
+
+* Display TOC in the custom sidebar, `data-sub-max-level`.
+* Custom background in coverpage.
 
 #### Bug fixes
-- Fix scroll highlight when Vue exist.
+
+* Fix scroll highlight when Vue exist.
 
 ### 1.3.5
+
 #### Bug fixes
-- Fix vue
+
+* Fix vue
 
 ### 1.3.4
+
 #### Bug fixes
 
-- Supports [vuep](https://github.com/QingWei-Li/vuep)
+* Supports [vuep](https://github.com/QingWei-Li/vuep)
 
 ### 1.3.3
+
 #### Bug fixes
-- Fixed cover rendering timing
+
+* Fixed cover rendering timing
 
 ### 1.3.2
 
 #### Bug fixes
-- Fixed render link
+
+* Fixed render link
 
 ### 1.3.1
 
 #### Bug fixes
-- Fixed cover page style
-- Generate the correct link when rendering the article
+
+* Fixed cover page style
+* Generate the correct link when rendering the article
 
 ### 1.3.0
+
 #### Features
-- Add cover page
-- add `<kbd>` style
-- headling can be cliked
+
+* Add cover page
+* add `<kbd>` style
+* headling can be cliked
 
 #### Bug fixes
-- sidebar highlight
 
+* sidebar highlight
 
 #### break change
-- Navbar no longer fixed at the top
+
+* Navbar no longer fixed at the top
 
 ### 1.2.0
+
 #### Features
-- custom basePath
-- custom homepage
+
+* custom basePath
+* custom homepage
 
 ### 1.1.7
+
 #### Bug fixes
-- Optimize progress bar
+
+* Optimize progress bar
 
 ### 1.1.6
+
 #### Features
-- Add logo 😂
+
+* Add logo 😂
 
 #### Bug fixes
-- Remove table background color
-- Fixed highlight sidebar using chinese ids
+
+* Remove table background color
+* Fixed highlight sidebar using chinese ids
 
 ### 1.1.5
+
 #### Features
+
 - Add table style
 
 #### Bug fixes
-- Not fixed position of hte navbar in the mobile browser
-- Correct calculation of whether the mobile browser
+
+* Not fixed position of hte navbar in the mobile browser
+* Correct calculation of whether the mobile browser
 
 ### 1.1.4
+
 #### Bug fixes
-- Fixed chinese auchor link
+
+* Fixed chinese auchor link
 
 ### 1.1.3
+
 #### Bug fixes
-- Optimize progress bar again
+
+* Optimize progress bar again
 
 ### 1.1.2
+
 #### Bug fixes
-- fix failed `auto2top` in mobile
+
+* fix failed `auto2top` in mobile
 
 
 ### 1.1.1
+
 #### Bug fixes
+
 - Optimize progress bar
 
 ### 1.1.0
+
 #### Features
-- Add progress bar
-- Add `auto2top` option for hash router
+
+* Add progress bar
+* Add `auto2top` option for hash router
 
 ### 1.0.3
+
 #### Bug fixes
+
 - Fix cache
 
 ### 1.0.2
+
 #### Bug fixes
-- Fix binding events bug, fixed #24
-- Fix regular expression, fixed #23
+
+* Fix binding events bug, fixed [#24](https://github.com/QingWei-Li/docsify/issues/24)
+* Fix regular expression, fixed [#23](https://github.com/QingWei-Li/docsify/issues/23)
 
 ### 1.0.1
+
 #### Bug fixes
-- `img` style
+
+* `img` style
 
 ### 1.0.0
+
 #### Features
-- Support hash router
+
+* Support hash router
 
 #### Bug fixes
-- Improved scrolling on mobile
+
+* Improved scrolling on mobile
 
 ### 0.7.0
+
 #### Breaking change
-- `themes/` was removed, only exists in the npm package.
+
+* `themes/` was removed, only exists in the npm package.
 
 #### Bug fixes
-- Fix style.
-- Fix sidebar animation again.
+
+* Fix style.
+* Fix sidebar animation again.
 
 ### 0.6.1
+
 #### Bug fixes
-- In the mobile, it should collapse the sidebar when toggle is clicked.
-- Fix the dropdown list style.
-- Fix sidebar animation.
+
+* In the mobile, it should collapse the sidebar when toggle is clicked.
+* Fix the dropdown list style.
+* Fix sidebar animation.
 
 ### 0.6.0
+
 #### Features
-- Navbar support dropdown list, #6
-- Sidebar with toggle
+
+* Navbar support dropdown list, [#6](https://github.com/QingWei-Li/docsify/issues/6)
+* Sidebar with toggle
 
 #### Bug fixes
-- Fix ineffective option, fixed #10
+
+* Fix ineffective option, fixed [#10](https://github.com/QingWei-Li/docsify/issues/10)
 
 ### 0.5.0
+
 #### Features
-- Custom sidebars and navbars by markdown file
+
+* Custom sidebars and navbars by markdown file
 
 ### 0.4.2
+
 #### Bug fixes
-- Correct catch ajax error
+
+* Correct catch ajax error
 
 ### 0.4.1
+
 #### Bug fixes
-- catch ajax error
+
+* catch ajax error
 
 ### 0.4.0
+
 #### Features
-- Custom sidebar
+
+* Custom sidebar
 
 #### Bug fixes
-- Fix undefined language
+
+* Fix undefined language
 
 ### 0.3.1
+
 #### Bug fixes
-- Strip HTML tag when rendering the headings
+
+* Strip HTML tag when rendering the headings
 
 ### 0.3.0
+
 #### Features
-- Add minified css files
-- Add max level option
-- Add pure.css
+
+* Add minified css files
+* Add max level option
+* Add pure.css
 
 ### 0.2.1
+
 #### Bug fixes
-- Fix vue.css
+
+* Fix vue.css
 
 ### 0.2.0
+
 #### Bug fixes
-- Fix route
-- Remove dynamic title
+
+* Fix route
+* Remove dynamic title
 
 ### 0.1.0
+
 #### Features
-- Add buble.css
+
+* Add buble.css

README.md

@@ -9,12 +9,13 @@
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/rust-lang/rust/master.svg?style=flat-square"></a>
+  <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://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
 </p>
 
 ## Links
+
 - [Documentation](https://docsify.js.org)
 - [CLI](https://github.com/QingWei-Li/docsify-cli)
 
@@ -28,7 +29,8 @@
 - Compatible with IE10+
 
 ## Quick start
-Create a `index.html`.
+
+Create an `index.html`.
 
 ```html
 <!-- index.html -->
@@ -37,12 +39,12 @@ Create a `index.html`.
 <html>
 <head>
   <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
 </head>
 <body>
   <div id="app"></div>
 </body>
-<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 </html>
 ```
 
@@ -51,18 +53,27 @@ Create a `index.html`.
 Modern browsers and Internet Explorer 10+.
 
 ## Showcase
+
 These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
 
-- [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
+| 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. |
 
 ## Similar projects
-- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
-- [docpress](https://github.com/docpress/docpress) - Documentation website generator
+
+| Project | Description |
+|---|---|
+| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
+| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
 
 ## Contributing
 
@@ -81,4 +92,5 @@ open http://localhost:3000
 ```
 
 ## License
+
 MIT

app.js

@@ -1,12 +1,51 @@
 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-ssr.js

@@ -0,0 +1,24 @@
+var rollup = require('rollup')
+var async = require('rollup-plugin-async')
+var isProd = process.argv[process.argv.length - 1] !== '--dev'
+
+rollup
+  .rollup({
+    entry: 'packages/docsify-server-renderer/index.js',
+    plugins: [
+      async()
+    ],
+    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,6 +2,7 @@ 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 isProd = process.argv[process.argv.length - 1] !== '--dev'
 
@@ -9,7 +10,12 @@ var build = function (opts) {
   rollup
     .rollup({
       entry: 'src/' + opts.entry,
-      plugins: [buble(), commonjs(), nodeResolve()].concat(opts.plugins || [])
+      plugins: (opts.plugins || []).concat([
+        string({ include: '**/*.css' }),
+        buble(),
+        commonjs(),
+        nodeResolve()
+      ])
     })
     .then(function (bundle) {
       var dest = 'lib/' + (opts.output || opts.entry)
@@ -34,8 +40,10 @@ build({
 var plugins = [
   { name: 'search', entry: 'search/index.js', moduleName: 'Search' },
   { name: 'ga', entry: 'ga.js', moduleName: 'GA' },
-  { name: 'emoji', entry: 'emoji.js', moduleName: 'Emoji' }
-  // { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' }
+  { name: 'emoji', entry: 'emoji.js', moduleName: 'Emoji' },
+  { name: 'external-script', entry: 'external-script.js', moduleName: 'ExternalScript' },
+  { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' },
+  { name: 'zoom-image', entry: 'zoom-image.js', moduleName: 'ZoomImage' }
 ]
 
 plugins.forEach(item => {

build/release.sh

@@ -0,0 +1,43 @@
+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 version $VERSION --message "[release] $VERSION $RELEASE_TAG"
+
+  # publish
+  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

@@ -7,28 +7,40 @@
   <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>
-  <nav data-cloak>
-    <a href="#/">EN</a>
-    <a href="#/zh-cn/">中文</a>
-  </nav>
   <div id="app"></div>
 </body>
 <script>
   window.$docsify = {
     alias: {
+      '/de-de/changelog': '/changelog',
       '/zh-cn/changelog': '/changelog',
       '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
     },
-    executeScript: true
+    auto2top: true,
+    basePath: '/docs/',
+    executeScript: true,
+    loadNavbar: true,
+    loadSidebar: true,
+    name: 'docsify',
+    subMaxLevel: 2,
+    mergeNavbar: true,
+    formatUpdated: '{MM}/{DD} {HH}:{mm}',
+    routerMode: 'history',
+    plugins: [
+      function(hook) {
+        hook.beforeEach(function (html) {
+          return html += '\n> Last modified {docsify-updated}'
+        })
+      }
+    ]
   }
 </script>
-<script
-  src="/lib/docsify.js"
-  data-name="docsify"
-  data-base-path="/docs/"
-  data-load-sidebar
-  data-sub-max-level="2"
-  data-auto2top></script>
+<script src="/lib/docsify.js"></script>
 </html>

docs/README.md

@@ -4,19 +4,19 @@
 
 ## 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).
+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) for more details.
+See the [Quick start](quickstart.md) for more details.
 
 ## Features
 
-- No statically built html files
-- Simple and lightweight (~16kB gzipped)
-- Smart full-text search plugin
-- Multiple themes
-- Useful plugin API
-- Emoji support
-- Compatible with IE10+
+* No statically built html files
+* Simple and lightweight (~16kB gzipped)
+* Smart full-text search plugin
+* Multiple themes
+* Useful plugin API
+* Emoji support
+* Compatible with IE10+
 
 ## Examples
 

docs/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)
 
-# docsify <small>3.2</small>
+# docsify <small>3.7</small>
 
 > A magical documentation site generator.
 

docs/_navbar.md

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

docs/_sidebar.md

@@ -1,22 +1,22 @@
 - Getting started
- - [Quick start](/quickstart)
- - [Writing more pages](/more-pages)
- - [Custom navbar](/custom-navbar)
- - [Cover page](/cover)
+  - [Quick start](quickstart.md)
+  - [Writing more pages](more-pages.md)
+  - [Custom navbar](custom-navbar.md)
+  - [Cover page](cover.md)
 
 - Customization
-  - [Configuration](/configuration)
-  - [Themes](/themes)
-  - [List of Plugins](/plugins)
-  - [Write a Plugin](/write-a-plugin)
-  - [Markdown configuration](/markdown)
-  - [Lanuage highlighting](/language-highlight)
+  - [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)
- - [Helpers](/helpers)
- - [Vue compatibility](/vue)
- - [CDN](/cdn)
- - [Offline Mode(PWA)](/pwa)
+  - [Deploy](deploy.md)
+  - [Helpers](helpers.md)
+  - [Vue compatibility](vue.md)
+  - [CDN](cdn.md)
+  - [Offline Mode(PWA)](pwa.md)
 
-- [Changelog](/changelog)
+- [Changelog](changelog.md)

docs/cdn.md

@@ -2,10 +2,8 @@
 
 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">
@@ -14,8 +12,9 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
 <script src="//unpkg.com/docsify/lib/docsify.js"></script>
 ```
 
-## Specific version
+Alternatively, use [compressed files](#compressed-files).
 
+## Specific version
 
 ```html
 <!-- load css -->
@@ -27,7 +26,6 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
 
 ## Compressed file
 
-
 ```html
 <!-- load css -->
 <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
@@ -36,7 +34,17 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
 <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
 
-[jsDelivr](http://www.jsdelivr.com/projects/docsify) is available.
+- http://www.bootcdn.cn/docsify
+- http://www.jsdelivr.com/projects/docsify
+- https://cdnjs.com/libraries/docsify
 

docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration
 
-docsify supports two ways to configure. You can configure the `window.$docsify` or write configuration on the script tag via `data-*` attributes.
+**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 -->
@@ -53,7 +53,6 @@ window.$docsify = {
 }
 ```
 
-
 ## max-level
 
 - Type: `Number`
@@ -72,7 +71,7 @@ window.$docsify = {
 - Type: `Boolean|String`
 - Default: `false`
 
-Load navbar from Markdown file. If **true** it will be loaded from `_navbar.md`.
+Loads navbar from the Markdown file `_navbar.md` if **true**, or else from the path specified.
 
 ```js
 window.$docsify = {
@@ -89,8 +88,7 @@ window.$docsify = {
 - Type: `Boolean|String`
 - Default: `false`
 
-
-Load sidebar from Markdown file. If **true** it will be loaded from `_sidebar.md`.
+Loads sidebar from the Markdown file `_sidebar.md` if **true**, or else from the path specified.
 
 ```js
 window.$docsify = {
@@ -107,7 +105,7 @@ window.$docsify = {
 - Type: `Number`
 - Default: `0`
 
-Add TOC in custom sidebar.
+Add table of contents (TOC) in custom sidebar.
 
 ```js
 window.$docsify = {
@@ -115,13 +113,11 @@ window.$docsify = {
 }
 ```
 
-
 ## auto2top
 
 - Type: `Boolean`
 - Default: `false`
 
-
 Scrolls to the top of the screen when the route is changed.
 
 ```js
@@ -130,13 +126,11 @@ window.$docsify = {
 }
 ```
 
-
 ## 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
@@ -167,13 +161,12 @@ window.$docsify = {
 }
 ```
 
-
 ## coverpage
 
 - Type: `Boolean|String`
 - Default: `false`
 
-Activate the [cover feature](/cover). If ture, it will load from `_coverpage.md`.
+Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`.
 
 ```js
 window.$docsify = {
@@ -188,8 +181,7 @@ window.$docsify = {
 
 - Type: `String`
 
-
-Website name appears in the sidebar.
+Website name as it appears in the sidebar.
 
 ```js
 window.$docsify = {
@@ -220,8 +212,7 @@ window.$docsify = {
 
 - Type: `Function`
 
-See [Markdown configuration](/markdown).
-
+See [Markdown configuration](markdown.md).
 
 ```js
 window.$docsify = {
@@ -247,8 +238,7 @@ window.$docsify = {
 
 - 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.
+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 = {
@@ -260,7 +250,6 @@ window.$docsify = {
 
 - Type: `Object`
 
-
 Set the route alias. You can freely manage routing rules.
 
 ```js
@@ -276,7 +265,7 @@ window.$docsify = {
 
 - 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. [#78](https://github.com/QingWei-Li/docsify/issues/78)
+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 = {
@@ -303,6 +292,51 @@ window.$docsify = {
 <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
+
+Disabled emoji parse.
+
+```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'
+}
+```

docs/cover.md

@@ -1,6 +1,6 @@
 # Cover
 
-Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage).
+Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).
 
 ## Basic usage
 
@@ -14,16 +14,15 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:
     coverpage: true
   }
 </script>
-<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 ```
 
-
 ```markdown
 <!-- _coverpage.md -->
 
 ![logo](_media/icon.svg)
 
-# docsify <small>3.0</small>
+# docsify <small>3.5</small>
 
 > A magical documentation site generator.
 
@@ -31,27 +30,27 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:
 - No statically built html files
 - Multiple themes
 
-
 [GitHub](https://github.com/QingWei-Li/docsify/)
 [Get Started](#docsify)
 ```
 
-!> A document site can have only one cover page.
+!> 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 image:
+The background color is generated randomly by default. You can customize the background color or a background image:
 
 ```markdown
 <!-- _coverpage.md -->
 
-# docsify
+# 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

@@ -2,7 +2,9 @@
 
 ## HTML
 
-If you need custom navigation, you can create a HTML-based navigation bar (but note that documentation links begin with `#/`).
+If you need custom navigation, you can create a HTML-based navigation bar.
+
+!> Note that documentation links begin with `#/`.
 
 ```html
 <!-- index.html -->
@@ -18,7 +20,7 @@ If you need custom navigation, you can create a HTML-based navigation bar (but n
 
 ## Markdown
 
-Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`. Details are available in the [load-navbar configuration paragraph](configuration#load-navbar).
+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 -->
@@ -28,10 +30,9 @@ Alternatively, you can create a custom markdown-based navigation file by setting
     loadNavbar: true
   }
 </script>
-<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 ```
 
-
 ```markdown
 <!-- _navbar.md -->
 
@@ -51,21 +52,44 @@ You can create sub-lists by indenting items that are under a certain parent.
 <!-- _navbar.md -->
 
 - Getting started
- - [Quick start](/quickstart)
- - [Writing more pages](/more-pages)
- - [Custom navbar](/custom-navbar)
- - [Cover page](/cover)
+  - [Quick start](quickstart.md)
+  - [Writing more pages](more-pages.md)
+  - [Custom navbar](custom-navbar.md)
+  - [Cover page](cover.md)
 
 - Configuration
-  - [Configuration](/configuration)
-  - [Themes](/themes)
-  - [Using plugins](/plugins)
-  - [Markdown configuration](/markdown)
-  - [Lanuage highlight](/language-highlight)
+  - [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,27 @@
+## 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 (~16kB gzipped)
+* smarte Erweiterung mit Volltextsuche
+* mehrere Themes
+* praktische API für Erweiterungen
+* Unterstützung für Emoji
+* Kompatibel mit IE10+
+
+## 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,22 @@
+- 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)
+
+- [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
+- http://www.jsdelivr.com/projects/docsify
+- https://cdnjs.com/libraries/docsify

docs/de-de/configuration.md

@@ -0,0 +1,342 @@
+# 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.
+
+```js
+window.$docsify = {
+  alias: {
+    '/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'
+}
+```

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 (~16kB 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,33 @@
+# 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.
+
+## 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,27 @@
+# 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

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,30 @@
+# 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
+  }
+}
+```

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,95 @@
+# 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'
+      }
+    }
+  }
+</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>
+```

docs/de-de/pwa.md

@@ -1,3 +1,16 @@
+# 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
  * ===========================================================
@@ -81,3 +94,22 @@ self.addEventListener('fetch', event => {
     )
   }
 })
+```
+
+## 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,87 @@
+# 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 charset="UTF-8">dict.
+  <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/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,70 @@
+# 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
+
+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
+      })
+    }
+  ]
+}
+```

docs/deploy.md

@@ -1,16 +1,16 @@
 # Deploy
 
-As as GitBook, you can deploy files to GitHub Pages or VPS.
+Similar to [GitBook](https://www.gitbook.com), you can deploy files to GitHub Pages or VPS.
 
 ## GitHub Pages
 
-There're three places to populate your docs
+There're three places to populate your docs for your Github repository:
 
-- `docs/` folder
-- master branch
-- gh-pages branch
+* `docs/` folder
+* master branch
+* gh-pages branch
 
-You can save your files in `./docs` and setting `master branch /docs folder`.
+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)
 

docs/helpers.md

@@ -4,23 +4,24 @@ docsify extends Markdown syntax to make your documents more readable.
 
 ## important content
 
-Suitable for displaying important information.
+Important content like:
 
 ```markdown
 !> **Time** is money, my friend!
 ```
 
-!> **Time** is money, my friend!
+is rendered as:
 
+!> **Time** is money, my friend!
 
 ## General tips
 
-General tips.
-
+General tips like:
 
 ```markdown
 ?> *TODO* unit test
 ```
 
-?> *TODO* unit test
+are rendered as:
 
+?> *TODO* unit test

docs/index.html

@@ -6,36 +6,57 @@
   <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="google-site-verification" content="6t0LoIeFksrjF4c9sqUEsVXiQNxLp2hgoqo0KryT-sE" />
   <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>
-  <nav data-cloak>
-    <a href="#/">En</a>
-    <a href="#/zh-cn/">中文</a>
-  </nav>
-  <div id="app"></div>
+  <div id="app">Loading ...</div>
 </body>
 <script>
   window.$docsify = {
-    name: 'docsify',
-    maxLevel: 4,
-    subMaxLevel: 2,
-    auto2top: true,
-    coverpage: true,
-    loadSidebar: true,
-    executeScript: true,
     alias: {
+      '/de-de/changelog': '/changelog',
       '/zh-cn/changelog': '/changelog',
       '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
-    }
-  }
-
-  if (typeof navigator.serviceWorker !== 'undefined') {
-    navigator.serviceWorker.register('sw.js')
+    },
+    auto2top: true,
+    coverpage: true,
+    executeScript: true,
+    loadSidebar: true,
+    loadNavbar: true,
+    mergeNavbar: true,
+    maxLevel: 4,
+    subMaxLevel: 2,
+    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) {
+        hook.beforeEach(function (html) {
+          return html += '\n> Last modified {docsify-updated}'
+        })
+      }
+    ]
   }
 </script>
 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

docs/language-highlight.md

@@ -1,13 +1,11 @@
 # language highlight
 
-
-The code language highlight tool is [Prism](https://github.com/PrismJS/prism). Only supports CSS, JavaScipt and HTML by default. You can load its component to highlight the language you need.
-
+**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"></script>
-<script src="//unpkg.com/prismjs/components/prism-bash.js"></script>
-<script src="//unpkg.com/prismjs/components/prism-php.js"></script>
+<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>
 ```
 
-?> See fully supported highlight component [files list](https://github.com/PrismJS/prism/tree/gh-pages/components).
+?> Check the [component files](https://github.com/PrismJS/prism/tree/gh-pages/components) list for more options.

docs/markdown.md

@@ -1,6 +1,6 @@
 # Markdown configuration
 
-The Markdown parser is [marked](https://github.com/chjj/marked). You can customize how docsify renders your Markdown content to HTML. Support customize `renderer`.
+**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 = {

docs/more-pages.md

@@ -5,17 +5,17 @@ If you need more pages, you can simply create more markdown files in your docsif
 For example, the directory structure is as follows:
 
 ```text
--| docs/
-  -| README.md
-  -| guide.md
-  -| zh-cn/
-    -| README.md
-    -| guide.md
+.
+└── 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
@@ -27,7 +27,7 @@ docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
 
 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#load-sidebar).
+First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#load-sidebar).
 
 ```html
 <!-- index.html -->
@@ -37,7 +37,7 @@ First, you need to set `loadSidebar` to **true**. Details are available in the [
     loadSidebar: true
   }
 </script>
-<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 ```
 
 Create the `_sidebar.md`:
@@ -46,7 +46,7 @@ Create the `_sidebar.md`:
 <!-- docs/_sidebar.md -->
 
 - [Home](/)
-- [Guide](/guide)
+- [Guide](guide.md)
 ```
 
 !> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
@@ -55,7 +55,7 @@ Create the `_sidebar.md`:
 
 ## Table of Contents
 
-A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`. Details are available in the [max-level configuration paragraph](configuration#sub-max-level).
+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 -->
@@ -66,5 +66,27 @@ A custom sidebar can also automatically generate a table of contents by setting
     subMaxLevel: 2
   }
 </script>
-<script src="//unpkg.com/docsify"></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

@@ -17,7 +17,7 @@ By default, the hyperlink on the current page is recognized and the content is s
       '/zh-cn/',      // => /zh-cn/README.md
     ],
 
-    // 完整配置参数
+    // complete configuration parameters
     search: {
       maxAge: 86400000, // Expiration time, the default one day
       paths: [], // or 'auto'
@@ -39,11 +39,10 @@ By default, the hyperlink on the current page is recognized and the content is s
     }
   }
 </script>
-<script src="//unpkg.com/docsify"></script>
-<script src="//unpkg.com/docsify/lib/plugins/search.js"></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.
@@ -54,24 +53,43 @@ Install the plugin and configure the track id.
     ga: 'UA-XXXXX-Y'
   }
 </script>
-<script src="//unpkg.com/docsify"></script>
-<script src="//unpkg.com/docsify/lib/plugins/ga.js"></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" data-ga="UA-XXXXX-Y"></script>
-<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+<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.js"></script>
+<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>
+```

docs/pwa.md

@@ -1,10 +1,12 @@
 # Offline Mode
 
-[Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/)(PWA) are experiences that combine the best of the web and the best of apps. we can enhance our website with service workers to work **offline** or on low-quality networks.
+[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 this code.
+
+Create a `sw.js` file in your documents root directory and copy the following code:
 
 *sw.js*
 
@@ -96,7 +98,7 @@ self.addEventListener('fetch', event => {
 
 ## Register
 
-Now, register it in your `index.html`. It only works on some modern browsers, so we need to judge.
+Now, register it in your `index.html`. It only works on some modern browsers, so we need to judge:
 
 *index.html*
 

docs/quickstart.md

@@ -8,7 +8,7 @@ npm i docsify-cli -g
 
 ## Initialize
 
-If you want to write the documentation in the `./docs` directory, you can use the `init` command.
+If you want to write the documentation in the `./docs` subdirectory, you can use the `init` command.
 
 ```bash
 docsify init ./docs
@@ -16,20 +16,18 @@ docsify init ./docs
 
 ## Writing content
 
-After the init is complete, you can see the file list in the docs directory.
+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
 
-- `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).
+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
 ```
@@ -38,7 +36,7 @@ docsify serve docs
 
 ## Manual initialization
 
-If you don't like npm or have trouble installing the tool, you can manually create `index.html`:
+If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`:
 
 ```html
 <!-- index.html -->
@@ -52,7 +50,7 @@ If you don't like npm or have trouble installing the tool, you can manually crea
 <body>
   <div id="app"></div>
 </body>
-<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 </html>
 ```
 
@@ -85,3 +83,5 @@ You should set the `data-app` attribute if you changed `el`:
     }
   </script>
 ```
+
+Compare [el configuration](configuration.md#el).

docs/ssr.config.js

@@ -0,0 +1,33 @@
+module.exports = {
+  config: {
+    alias: {
+      '/de-de/changelog': '/changelog',
+      '/zh-cn/changelog': '/changelog',
+      '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+    },
+    auto2top: true,
+    coverpage: true,
+    executeScript: true,
+    loadSidebar: true,
+    loadNavbar: true,
+    mergeNavbar: true,
+    maxLevel: 4,
+    subMaxLevel: 2,
+    basePath: '/docs/',
+    name: 'docsify',
+    search: {
+      noData: {
+        '/de-de/': 'Keine Ergebnisse!',
+        '/zh-cn/': '没有结果!',
+        '/': 'No results!'
+      },
+      paths: 'auto',
+      placeholder: {
+        '/de-de/': 'Suche',
+        '/zh-cn/': '搜索',
+        '/': 'Search'
+      }
+    }
+  },
+  template: './docs/ssr.html'
+}

docs/ssr.html

@@ -0,0 +1,29 @@
+<!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@next/lib/themes/vue.css" title="vue">
+  <!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/dark.css" title="dark" disabled> -->
+  <!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/buble.css" title="buble" disabled> -->
+  <!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/pure.css" title="pure" disabled> -->
+  <style>
+    nav.app-nav li ul {
+      min-width: 100px;
+    }
+  </style>
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+</body>
+<script src="/lib/docsify.js"></script>
+<script src="/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>

docs/ssr.md

@@ -0,0 +1,3 @@
+# Server client renderer
+
+See https://docsify.now.sh

docs/themes.md

@@ -2,35 +2,43 @@
 
 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/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">
 ```
 
-!> This compressed files in `/lib/themes/`.
+!> Compressed files are available in `/lib/themes/`.
 
-If you have any ideas or would like to develop new theme, welcome submit [PR](https://github.com/QingWei-Li/docsify/pulls).
+```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 {
-    text-decoration: underline;
     cursor: pointer;
+    text-decoration: underline;
   }
 </style>
 

docs/vue.md

@@ -1,19 +1,21 @@
 # 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.
+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`.
+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.
+Then you can immediately write Vue code at Markdown file. `new Vue({ el: '#main' })` script is executed by default to create instance.
 
 *README.md*
 
@@ -59,9 +61,18 @@ You can manually initialize a Vue instance.
 *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*
@@ -70,7 +81,7 @@ You can manually initialize a Vue instance.
 
 <vuep template="#example"></vuep>
 
-<script type="text/x-template" id="example">
+<script v-pre type="text/x-template" id="example">
   <template>
     <div>Hello, {{ name }}!</div>
   </template>
@@ -85,5 +96,4 @@ You can manually initialize a Vue instance.
 </script>
 ```
 
-?> Example Refer to the vuep [documentation](https://qingwei-li.github.io/vuep/).
-
+?> Example Refer to the [vuep documentation](https://qingwei-li.github.io/vuep/).

docs/write-a-plugin.md

@@ -1,7 +1,6 @@
 # Write a plugin
 
-A plugin is simply a function that takes `hook` as arguments.
-The hook supports handling asynchronous tasks.
+A plugin is simply a function that takes `hook` as an argument. The hook supports handling of asynchronous tasks.
 
 ## Full configuration
 
@@ -68,4 +67,4 @@ window.$docsify = {
     }
   ]
 }
-```
+```

docs/zh-cn/README.md

@@ -6,9 +6,9 @@
 
 docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件，所有转换工作都是在运行时进行。
 
-这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy)。
+这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)。
 
-查看[快速开始](zh-cn/quickstart)了解详情。
+查看[快速开始](zh-cn/quickstart.md)了解详情。
 
 ## 特性
 - 无需构建，写完文档直接发布

docs/zh-cn/_sidebar.md

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

docs/zh-cn/cdn.md

@@ -44,5 +44,6 @@ JS 的压缩文件是原有文件路径的基础上加 `.min`后缀
 
 ## 其他 CDN
 
-[jsDelivr](http://www.jsdelivr.com/projects/docsify) 也是可用的，具体用法参考其文档。
-
+- http://www.bootcdn.cn/docsify
+- http://www.jsdelivr.com/projects/docsify
+- https://cdnjs.com/libraries/docsify

docs/zh-cn/configuration.md

@@ -74,7 +74,7 @@ window.$docsify = {
 - 类型：`Boolean|String`
 - 默认值: `false`
 
-加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。
+加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar.md) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。
 
 ```js
 window.$docsify = {
@@ -91,7 +91,7 @@ window.$docsify = {
 - 类型：`Boolean|String`
 - 默认值: `false`
 
-加载自定义侧边栏，参考[多页文档](zh-cn/more-pages)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。
+加载自定义侧边栏，参考[多页文档](zh-cn/more-pages.md)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。
 
 ```js
 window.$docsify = {
@@ -173,7 +173,7 @@ window.$docsify = {
 - 类型：`Boolean|String`
 - 默认值: `false`
 
-启用[封面页](/zh-cn/cover)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。
+启用[封面页](zh-cn/cover.md)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。
 
 ```js
 window.$docsify = {
@@ -220,7 +220,7 @@ window.$docsify = {
 
 - 类型: `Object|Function`
 
-参考 [Markdown 配置](/zh-cn/markdown)。
+参考 [Markdown 配置](zh-cn/markdown.md)。
 
 ```js
 window.$docsify = {
@@ -287,7 +287,7 @@ window.$docsify = {
 
 - 类型：`Boolean`
 
-执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes))。 如果 Vue 存在，则自动开启。
+执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes.md))。 如果 Vue 存在，则自动开启。
 
 ```js
 window.$docsify = {
@@ -304,3 +304,49 @@ window.$docsify = {
 
 ```
 
+注意如果执行的是一个外链脚本，比如 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'
+}
+```

docs/zh-cn/cover.md

@@ -1,6 +1,6 @@
 # 封面
 
-通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](zh-cn/configuration#coverpage)。
+通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](configuration.md#coverpage)。
 
 ## 基本用法
 

docs/zh-cn/custom-navbar.md

@@ -17,7 +17,7 @@
 
 ## 配置文件
 
-那我们可以通过 Markdown 文件来配置导航。首先配置 `loadNavbar`，默认加载的文件为 `_navbar.md`。具体配置规则见[配置项#load-navbar](zh-cn/configuration#load-navbar)。
+那我们可以通过 Markdown 文件来配置导航。首先配置 `loadNavbar`，默认加载的文件为 `_navbar.md`。具体配置规则见[配置项#load-navbar](configuration.md#load-navbar)。
 
 *index.html*
 
@@ -49,17 +49,17 @@
 
 ```markdown
 - 基础
- - [快速开始](zh-cn/quickstart)
- - [多页文档](zh-cn/more-pages)
- - [定制导航栏](zh-cn/custom-navbar)
- - [封面](zh-cn/cover)
+ - [快速开始](zh-cn/quickstart.md)
+ - [多页文档](zh-cn/more-pages.md)
+ - [定制导航栏](zh-cn/custom-navbar.md)
+ - [封面](zh-cn/cover.md)
 
 - 配置
-  - [配置项](zh-cn/configuration)
-  - [主题](zh-cn/themes)
-  - [使用插件](zh-cn/plugins)
-  - [Markdown 配置](zh-cn/markdown)
-  - [代码高亮](zh-cn/language-highlight)
+  - [配置项](zh-cn/configuration.md)
+  - [主题](zh-cn/themes.md)
+  - [使用插件](zh-cn/plugins.md)
+  - [Markdown 配置](zh-cn/markdown.md)
+  - [代码高亮](zh-cn/language-highlight.md)
 ```
 
 效果图

docs/zh-cn/more-pages.md

@@ -26,7 +26,7 @@ docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
 
 默认情况下，侧边栏会根据当前文档的标题生成目录。也可以设置文档链接，通过 Markdown 文件生成，效果如当前的文档的侧边栏。
 
-首先配置 `loadSidebar` 选项，具体配置规则见[配置项#load-sidebar](zh-cn/configuration#load-sidebar)。
+首先配置 `loadSidebar` 选项，具体配置规则见[配置项#load-sidebar](configuration.md#load-sidebar)。
 
 ```html
 <script>
@@ -63,4 +63,25 @@ docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
 <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

@@ -71,3 +71,19 @@
 ```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>
+```

docs/zh-cn/quickstart.md

@@ -22,7 +22,7 @@ docsify init ./docs
 - `README.md` 会做为主页内容渲染
 - `.nojekyll` 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
 
-直接编辑 `docs/README.md` 就能更新网站内容，当然也可以[写多个页面](zh-cn/more-pages)。
+直接编辑 `docs/README.md` 就能更新网站内容，当然也可以[写多个页面](zh-cn/more-pages.md)。
 
 ## 本地预览网站
 

docs/zh-cn/themes.md

@@ -6,10 +6,18 @@
   <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)。
 
 #### 点击切换主题
@@ -19,6 +27,7 @@
   <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>
 
 

docs/zh-cn/vue.md

@@ -58,9 +58,18 @@
 *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*
@@ -69,7 +78,7 @@
 
 <vuep template="#example"></vuep>
 
-<script type="text/x-template" id="example">
+<script v-pre type="text/x-template" id="example">
   <template>
     <div>Hello, {{ name }}!</div>
   </template>
@@ -84,4 +93,20 @@
 </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/)。

lib/plugins/external-script.js

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

lib/plugins/front-matter.js

@@ -0,0 +1,503 @@
+this.D = this.D || {};
+(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
+  });
+};
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+
+}());

lib/plugins/ga.js

@@ -11,24 +11,28 @@ function appendScript () {
 }
 
 function init (id) {
-  if (!window.ga) {
+  var ga = window.ga;
+
+  if (!ga) {
     appendScript();
-    window.ga = window.ga || function () {
-      (window.ga.q = window.ga.q || []).push(arguments);
+    ga = ga || function () {
+      (ga.q = ga.q || []).push(arguments);
     };
-    window.ga.l = Number(new Date());
-    window.ga('create', id, 'auto');
+    ga.l = Number(new Date());
+    ga('create', id, 'auto');
   }
+  return ga
 }
 
 function collect () {
-  init(window.$docsify.ga);
-  window.ga('set', 'page', location.href);
-  window.ga('send', 'pageview');
+  var ga = init($docsify.ga);
+
+  ga('set', 'page', location.hash);
+  ga('send', 'pageview');
 }
 
 var install = function (hook) {
-  if (!window.$docsify.ga) {
+  if (!$docsify.ga) {
     console.error('[Docsify] ga is required.');
     return
   }
@@ -36,6 +40,6 @@ var install = function (hook) {
   hook.beforeEach(collect);
 };
 
-window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+$docsify.plugins = [].concat(install, $docsify.plugins);
 
 }());

lib/plugins/ga.min.js

@@ -1 +1 @@
-this.D=this.D||{},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){window.ga||(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(){o(window.$docsify.ga),window.ga("set","page",location.href),window.ga("send","pageview")}var w=function(n){return window.$docsify.ga?void n.beforeEach(i):void console.error("[Docsify] ga is required.")};window.$docsify.plugins=[].concat(w,window.$docsify.plugins)}();
+this.D=this.D||{},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 c(c){var e=window.ga;return e||(n(),e=e||function(){(e.q=e.q||[]).push(arguments)},e.l=Number(new Date),e("create",c,"auto")),e}function e(){var n=c($docsify.ga);n("set","page",location.hash),n("send","pageview")}var i=function(n){if(!$docsify.ga)return void console.error("[Docsify] ga is required.");n.beforeEach(e)};$docsify.plugins=[].concat(i,$docsify.plugins)}();

lib/plugins/search.js

@@ -18,18 +18,18 @@ function escapeHtml (string) {
   return String(string).replace(/[&<>"'\/]/g, function (s) { return entityMap[s]; })
 }
 
-function getAllPaths () {
+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 = helper.route.parse(href).path;
+      var path = router.parse(href).path;
 
       if (path &&
         paths.indexOf(path) === -1 &&
-        !helper.route.isAbsolutePath(originHref)) {
+        !Docsify.util.isAbsolutePath(originHref)) {
         paths.push(path);
       }
     });
@@ -42,18 +42,17 @@ function saveData (maxAge) {
   localStorage.setItem('docsify.search.index', JSON.stringify(INDEXS));
 }
 
-function genIndex (path, content) {
+function genIndex (path, content, router) {
   if ( content === void 0 ) content = '';
 
   var tokens = window.marked.lexer(content);
   var slugify = window.Docsify.slugify;
-  var toURL = Docsify.route.toURL;
   var index = {};
   var slug;
 
   tokens.forEach(function (token) {
     if (token.type === 'heading' && token.depth <= 2) {
-      slug = toURL(path, { id: slugify(token.text) });
+      slug = router.toURL(path, { id: slugify(token.text) });
       index[slug] = { slug: slug, title: token.text, body: '' };
     } else {
       if (!slug) { return }
@@ -79,7 +78,7 @@ function search (keywords) {
     data = data.concat(Object.keys(INDEXS[key]).map(function (page) { return INDEXS[key][page]; }));
   });
 
-  keywords = keywords.trim().split(/[\s\-\，\\/]+/);
+  keywords = [].concat(keywords, keywords.trim().split(/[\s\-\，\\/]+/));
 
   var loop = function ( i ) {
     var post = data[i];
@@ -153,7 +152,7 @@ function init$1 (config, vm) {
     return
   }
 
-  var paths = isAuto ? getAllPaths() : config.paths;
+  var paths = isAuto ? getAllPaths(vm.router) : config.paths;
   var len = paths.length;
   var count = 0;
 
@@ -161,73 +160,78 @@ function init$1 (config, vm) {
     if (INDEXS[path]) { return count++ }
 
     helper
-      .get(vm.$getFile(path))
+      .get(vm.router.getFile(path))
       .then(function (result) {
-        INDEXS[path] = genIndex(path, result);
+        INDEXS[path] = genIndex(path, result, vm.router);
         len === ++count && saveData(config.maxAge);
       });
   });
 }
 
-var dom;
 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}\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}";
-  var style = dom.create('style', code);
-  dom.appendTo(dom.head, 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}";
+  var style = Docsify.dom.create('style', code);
+  Docsify.dom.appendTo(Docsify.dom.head, style);
 }
 
-function tpl (opts) {
+function tpl (opts, defaultValue) {
+  if ( defaultValue === void 0 ) defaultValue = '';
+
   var html =
-    "<input type=\"search\" />" +
+    "<input type=\"search\" value=\"" + defaultValue + "\" />" +
       '<div class="results-panel"></div>' +
     '</div>';
-  var el = dom.create('div', html);
-  var aside = dom.find('aside');
+  var el = Docsify.dom.create('div', html);
+  var aside = Docsify.dom.find('aside');
 
-  dom.toggleClass(el, 'search');
-  dom.before(aside, el);
+  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 = dom.find('div.search');
-  var $input = dom.find($search, 'input');
-  var $panel = dom.find($search, '.results-panel');
-  var doSearch = function (value) {
-    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>");
-  };
+  var $search = Docsify.dom.find('div.search');
+  var $input = Docsify.dom.find($search, 'input');
 
   var timeId;
   // Prevent to Fold sidebar
-  dom.on($search, 'click',
+  Docsify.dom.on($search, 'click',
     function (e) { return e.target.tagName !== 'A' && e.stopPropagation(); });
-  dom.on($input, 'input', function (e) {
+  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 = dom.getNode('.search input[type="search"]');
+  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).find(function (key) { return path.indexOf(key) > -1; });
+    var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
     $input.placeholder = text[match];
   }
 }
@@ -236,16 +240,18 @@ function updateNoData (text, path) {
   if (typeof text === 'string') {
     NO_DATA_TEXT = text;
   } else {
-    var match = Object.keys(text).find(function (key) { return path.indexOf(key) > -1; });
+    var match = Object.keys(text).filter(function (key) { return path.indexOf(key) > -1; })[0];
     NO_DATA_TEXT = text[match];
   }
 }
 
-function init$$1 (opts) {
-  dom = Docsify.dom;
+function init$$1 (opts, vm) {
+  var keywords = vm.router.parse().query.s;
+
   style();
-  tpl(opts);
+  tpl(opts, keywords);
   bindEvents();
+  keywords && setTimeout(function (_) { return doSearch(keywords); }, 500);
 }
 
 function update (opts, vm) {
@@ -276,7 +282,7 @@ var install = function (hook, vm) {
   var isAuto = CONFIG.paths === 'auto';
 
   hook.mounted(function (_) {
-    init$$1(CONFIG);
+    init$$1(CONFIG, vm);
     !isAuto && init$1(CONFIG, vm);
   });
   hook.doneEach(function (_) {
@@ -285,6 +291,6 @@ var install = function (hook, vm) {
   });
 };
 
-window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+$docsify.plugins = [].concat(install, $docsify.plugins);
 
 }());

lib/plugins/search.min.js

@@ -1 +1 @@
-this.D=this.D||{},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(){var e=[];return d.dom.findAll("a:not([data-nosearch])").map(function(n){var t=n.href,o=n.getAttribute("href"),a=d.route.parse(t).path;a&&e.indexOf(a)===-1&&!d.route.isAbsolutePath(o)&&e.push(a)}),e}function t(e){localStorage.setItem("docsify.search.expires",Date.now()+e),localStorage.setItem("docsify.search.index",JSON.stringify(g))}function o(e,n){void 0===n&&(n="");var t,o=window.marked.lexer(n),a=window.Docsify.slugify,i=Docsify.route.toURL,r={};return o.forEach(function(n){if("heading"===n.type&&n.depth<=2)t=i(e,{id:a(n.text)}),r[t]={slug:t,title:n.text,body:""};else{if(!t)return;r[t]?r[t].body?r[t].body+="\n"+(n.text||""):r[t].body=n.text:r[t]={slug:t,title:"",body:""}}}),a.clear(),r}function a(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=n.trim().split(/[\s\-\，\\\/]+/);for(var a=function(a){var i=o[a],r=!1,s="",c=i.title&&i.title.trim(),l=i.body&&i.body.trim(),u=i.slug||"";if(c&&l&&(n.forEach(function(n,t){var o=new RegExp(n,"gi"),a=-1,i=-1;if(a=c&&c.search(o),i=l&&l.search(o),a<0&&i<0)r=!1;else{r=!0,i<0&&(i=0);var u=0,f=0;u=i<11?0:i-10,f=0===u?70:i+n.length+60,f>l.length&&(f=l.length);var p="..."+e(l).substring(u,f).replace(o,'<em class="search-keyword">'+n+"</em>")+"...";s+=p}}),r)){var f={title:e(c),content:s,url:u};t.push(f)}},i=0;i<o.length;i++)a(i);return t}function i(e,a){d=Docsify;var i="auto"===e.paths,r=localStorage.getItem("docsify.search.expires")<Date.now();if(g=JSON.parse(localStorage.getItem("docsify.search.index")),r)g={};else if(!i)return;var s=i?n():e.paths,c=s.length,l=0;s.forEach(function(n){return g[n]?l++:void d.get(a.$getFile(n)).then(function(a){g[n]=o(n,a),c===++l&&t(e.maxAge)})})}function r(){var e="\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}\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}",n=h.create("style",e);h.appendTo(h.head,n)}function s(e){var n='<input type="search" /><div class="results-panel"></div></div>',t=h.create("div",n),o=h.find("aside");h.toggleClass(t,"search"),h.before(o,t)}function c(){var e,n=h.find("div.search"),t=h.find(n,"input"),o=h.find(n,".results-panel"),i=function(e){if(!e)return o.classList.remove("show"),void(o.innerHTML="");var n=a(e),t="";n.forEach(function(e){t+='<div class="matching-post">\n  <h2><a href="'+e.url+'">'+e.title+"</a></h2>\n  <p>"+e.content+"</p>\n</div>"}),o.classList.add("show"),o.innerHTML=t||'<p class="empty">'+y+"</p>"};h.on(n,"click",function(e){return"A"!==e.target.tagName&&e.stopPropagation()}),h.on(t,"input",function(n){clearTimeout(e),e=setTimeout(function(e){return i(n.target.value.trim())},100)})}function l(e,n){var t=h.getNode('.search input[type="search"]');if("string"==typeof e)t.placeholder=e;else{var o=Object.keys(e).find(function(e){return n.indexOf(e)>-1});t.placeholder=e[o]}}function u(e,n){if("string"==typeof e)y=e;else{var t=Object.keys(e).find(function(e){return n.indexOf(e)>-1});y=e[t]}}function f(e){h=Docsify.dom,r(),s(e),c()}function p(e,n){l(e.placeholder,n.route.path),u(e.noData,n.route.path)}var d,h,g={},y="",m={placeholder:"Type to search",noData:"No Results!",paths:"auto",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);var a="auto"===m.paths;e.mounted(function(e){f(m),!a&&i(m,n)}),e.doneEach(function(e){p(m,n),a&&i(m,n)})};window.$docsify.plugins=[].concat(v,window.$docsify.plugins)}();
+this.D=this.D||{},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(y))}function o(e,n,t){void 0===n&&(n="");var o,i=window.marked.lexer(n),r=window.Docsify.slugify,a={};return i.forEach(function(n){if("heading"===n.type&&n.depth<=2)o=t.toURL(e,{id:r(n.text)}),a[o]={slug:o,title:n.text,body:""};else{if(!o)return;a[o]?a[o].body?a[o].body+="\n"+(n.text||""):a[o].body=n.text:a[o]={slug:o,title:"",body:""}}}),r.clear(),a}function i(n){var t=[],o=[];Object.keys(y).forEach(function(e){o=o.concat(Object.keys(y[e]).map(function(n){return y[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(),f=r.body&&r.body.trim(),l=r.slug||"";if(c&&f&&(n.forEach(function(n,t){var o=new RegExp(n,"gi"),i=-1,r=-1;if(i=c&&c.search(o),r=f&&f.search(o),i<0&&r<0)a=!1;else{a=!0,r<0&&(r=0);var l=0,d=0;l=r<11?0:r-10,d=0===l?70:r+n.length+60,d>f.length&&(d=f.length);var u="..."+e(f).substring(l,d).replace(o,'<em class="search-keyword">'+n+"</em>")+"...";s+=u}}),a)){var d={title:e(c),content:s,url:l};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(y=JSON.parse(localStorage.getItem("docsify.search.index")),a)y={};else if(!r)return;var s=r?n(i.router):e.paths,c=s.length,f=0;s.forEach(function(n){if(y[n])return f++;h.get(i.router.getFile(n)).then(function(r){y[n]=o(n,r,i.router),c===++f&&t(e.maxAge)})})}function a(){var e=Docsify.dom.create("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}");Docsify.dom.appendTo(Docsify.dom.head,e)}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">'+m+"</p>"}function f(){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 l(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)m=e;else{var t=Object.keys(e).filter(function(e){return n.indexOf(e)>-1})[0];m=e[t]}}function u(e,n){var t=n.router.parse().query.s;a(),s(e,t),f(),t&&setTimeout(function(e){return c(t)},500)}function p(e,n){l(e.placeholder,n.route.path),d(e.noData,n.route.path)}var h,y={},m="",g={placeholder:"Type to search",noData:"No Results!",paths:"auto",maxAge:864e5},v=function(e,n){var t=Docsify.util,o=n.config.search||g;Array.isArray(o)?g.paths=o:"object"==typeof o&&(g.paths=Array.isArray(o.paths)?o.paths:"auto",g.maxAge=t.isPrimitive(o.maxAge)?o.maxAge:g.maxAge,g.placeholder=o.placeholder||g.placeholder,g.noData=o.noData||g.noData);var i="auto"===g.paths;e.mounted(function(e){u(g,n),!i&&r(g,n)}),e.doneEach(function(e){p(g,n),i&&r(g,n)})};$docsify.plugins=[].concat(v,$docsify.plugins)}();

lib/plugins/zoom-image.js

@@ -0,0 +1,304 @@
+this.D = this.D || {};
+(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 @@
+this.D=this.D||{},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)}();

package.json

@@ -1,7 +1,18 @@
 {
   "name": "docsify",
-  "version": "3.2.0",
+  "version": "4.0.2",
   "description": "A magical documentation generator.",
+  "author": {
+    "name": "qingwei-li",
+    "email": "cinwell.li@gmail.com",
+    "url": "https://github.com/QingWei-Li"
+  },
+  "homepage": "https://docsify.js.org",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/QingWei-Li/docsify.git"
+  },
   "main": "lib/docsify.js",
   "files": [
     "lib",
@@ -9,14 +20,36 @@
     "themes"
   ],
   "scripts": {
-    "build": "rm -rf lib themes && node build/build.js && mkdir lib/themes && mkdir themes && node build/build-css.js",
-    "dev:build": "rm -rf lib themes && mkdir themes && node build/build.js --dev && node build/build-css.js --dev",
-    "dev": "node app.js & nodemon -w src -e js,css --exec 'npm run dev:build'",
-    "test": "eslint src"
+    "build": "rm -rf lib themes && node build/build && mkdir lib/themes && mkdir themes && node build/build-css && npm run build:ssr",
+    "dev:build": "rm -rf lib themes && mkdir themes && node build/build --dev && node build/build-css --dev",
+    "dev": "node app & nodemon -w src -e js,css --exec 'npm run dev:build'",
+    "build:ssr": "node build/build-ssr",
+    "test": "eslint {src,packages} --fix",
+    "pub:next": "RELEASE_TAG=next sh build/release.sh",
+    "pub": "sh build/release.sh"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/QingWei-Li/docsify.git"
+  "dependencies": {
+    "marked": "^0.3.6",
+    "prismjs": "^1.6.0",
+    "tinydate": "^1.0.0",
+    "zoom-image": "^0.1.4"
+  },
+  "devDependencies": {
+    "cssnano": "^3.10.0",
+    "eslint": "^3.18.0",
+    "eslint-config-vue": "^2.0.2",
+    "eslint-plugin-vue": "^2.0.1",
+    "nodemon": "^1.11.0",
+    "postcss": "^5.2.16",
+    "postcss-salad": "^1.0.8",
+    "rollup": "^0.41.6",
+    "rollup-plugin-async": "^1.2.0",
+    "rollup-plugin-buble": "^0.15.0",
+    "rollup-plugin-commonjs": "^8.0.2",
+    "rollup-plugin-node-resolve": "^2.0.0",
+    "rollup-plugin-string": "^2.0.2",
+    "rollup-plugin-uglify": "^1.0.1",
+    "serve-static": "^1.12.1"
   },
   "keywords": [
     "doc",
@@ -24,27 +57,5 @@
     "documentation",
     "creator",
     "generator"
-  ],
-  "author": "qingwei-li <cinwell.li@gmail.com> (https://github.com/QingWei-Li)",
-  "homepage": "https://docsify.js.org",
-  "license": "MIT",
-  "devDependencies": {
-    "cssnano": "^3.8.1",
-    "eslint": "^3.10.2",
-    "eslint-config-vue": "^2.0.1",
-    "eslint-plugin-vue": "^1.0.0",
-    "nodemon": "^1.11.0",
-    "postcss": "^5.2.6",
-    "postcss-salad": "^1.0.5",
-    "rollup": "^0.41.1",
-    "rollup-plugin-buble": "^0.15.0",
-    "rollup-plugin-commonjs": "^7.0.0",
-    "rollup-plugin-node-resolve": "^2.0.0",
-    "rollup-plugin-uglify": "^1.0.1",
-    "serve-static": "^1.11.1"
-  },
-  "dependencies": {
-    "marked": "^0.3.6",
-    "prismjs": "^1.5.1"
-  }
+  ]
 }

packages/docsify-server-renderer/.gitignore

@@ -0,0 +1,4 @@
+build.js
+node_modules
+*.log
+.git

packages/docsify-server-renderer/README.md

@@ -0,0 +1,46 @@
+# docsify-server-renderer
+
+## Install
+
+```bash
+yarn add docsify-server-render
+```
+
+## Usage
+
+```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 => {})
+```
+
+*index.template.html*
+
+```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/buble.css" title="buble" disabled>
+</head>
+<body>
+  <!--inject-app-->
+  <!--inject-config-->
+  <script src="//unpkg.com/docsify/lib/docsify.js"></script>
+</body>
+</html>
+```

packages/docsify-server-renderer/index.js

@@ -0,0 +1,137 @@
+import * as tpl from '../../src/core/render/tpl'
+import fetch from 'node-fetch'
+import { AbstractHistory } from '../../src/core/router/history/abstract'
+import { Compiler } from '../../src/core/render/compiler'
+import { isAbsolutePath } from '../../src/core/router/util'
+import { readFileSync } from 'fs'
+import { resolve, basename } from 'path'
+
+function cwd (...args) {
+  return resolve(process.cwd(), ...args)
+}
+
+function mainTpl (config) {
+  let html = `<nav class="app-nav${config.repo ? '' : ' no-badge'}"><!--navbar--></nav>`
+
+  if (config.repo) {
+    html += tpl.corner(config.repo)
+  }
+  if (config.coverpage) {
+    html += tpl.cover()
+  }
+
+  html += tpl.main(config)
+
+  return html
+}
+
+export default class Renderer {
+  constructor ({
+    template,
+    config,
+    cache
+  }) {
+    this.html = template
+    this.config = config = Object.assign({}, config, {
+      routerMode: 'history'
+    })
+    this.cache = cache
+
+    this.router = new AbstractHistory(config)
+    this.compiler = new Compiler(config, this.router)
+
+    this.router.getCurrentPath = () => this.url
+    this._renderHtml('inject-config', `<script>window.$docsify = ${JSON.stringify(config)}</script>`)
+    this._renderHtml('inject-app', mainTpl(config))
+
+    this.template = this.html
+  }
+
+  _getPath (url) {
+    const file = this.router.getFile(url)
+
+    return isAbsolutePath(file)
+      ? file
+      : cwd(`./${file}`)
+  }
+
+  async renderToString (url) {
+    this.url = url = this.router.parse(url).path
+    const { loadSidebar, loadNavbar } = this.config
+
+    const mainFile = this._getPath(url)
+    this._renderHtml('main', await this._render(mainFile))
+
+    if (loadSidebar) {
+      const name = loadSidebar === true ? '_sidebar.md' : loadSidebar
+      const sidebarFile = this._getPath(resolve(url, `../${name}`))
+      this._renderHtml('sidebar', await this._render(sidebarFile, 'sidebar'))
+    }
+
+    if (loadNavbar) {
+      const name = loadNavbar === true ? '_navbar.md' : loadNavbar
+      const navbarFile = this._getPath(resolve(url, `../${name}`))
+      this._renderHtml('navbar', await this._render(navbarFile, 'navbar'))
+    }
+
+    const html = this.html
+    this.html = this.template
+
+    return html
+  }
+
+  _renderHtml (match, content) {
+    this.html = this.html.replace(new RegExp(`<!--${match}-->`, 'g'), content)
+
+    return this.html
+  }
+
+  async _render (path, type) {
+    let html = await this._loadFile(path)
+    const { subMaxLevel, maxLevel } = this.config
+
+    switch (type) {
+      case 'sidebar':
+        html = this.compiler.sidebar(html, maxLevel) +
+          `<script>window.__SUB_SIDEBAR__ = ${JSON.stringify(
+            this.compiler.subSidebar(html, subMaxLevel)
+          )}</script>`
+        break
+      case 'cover':
+        html = this.compiler.cover(html)
+        break
+      case 'navbar':
+      case 'article':
+      default:
+        html = this.compiler.compile(html)
+        break
+    }
+
+    return html
+  }
+
+  async _loadFile (filePath) {
+    let content
+    try {
+      if (isAbsolutePath(filePath)) {
+        const res = await fetch(filePath)
+        content = await res.text()
+        this.lock = 0
+      } else {
+        content = await readFileSync(filePath, 'utf8')
+        this.lock = 0
+      }
+      return content
+    } catch (e) {
+      this.lock = this.lock || 0
+      if (++this.lock > 10) {
+        this.lock = 0
+        return
+      }
+
+      const fileName = basename(filePath)
+
+      await this._loadFile(cwd(filePath, '../..', fileName))
+    }
+  }
+}

packages/docsify-server-renderer/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "docsify-server-renderer",
+  "version": "4.0.2",
+  "description": "docsify server renderer",
+  "author": {
+    "name": "qingwei-li",
+    "email": "cinwell.li@gmail.com",
+    "url": "https://github.com/QingWei-Li"
+  },
+  "homepage": "https://docsify.js.org",
+  "license": "MIT",
+  "repository": "QingWei-Li/docsify",
+  "main": "build.js",
+  "scripts": {
+    "test": "echo 'hello'"
+  },
+  "dependencies": {
+    "node-fetch": "^1.7.0"
+  }
+}

src/core/config.js

@@ -16,7 +16,12 @@ const config = merge({
   nameLink: window.location.pathname,
   autoHeader: false,
   executeScript: null,
-  ga: ''
+  noEmoji: false,
+  ga: '',
+  mergeNavbar: false,
+  formatUpdated: '',
+  externalLinkTarget: '_blank',
+  routerModel: 'hash'
 }, window.$docsify)
 
 const script = document.currentScript ||

src/core/event/index.js

@@ -6,13 +6,13 @@ import { scrollIntoView } from './scroll'
 export function eventMixin (proto) {
   proto.$resetEvents = function () {
     scrollIntoView(this.route.query.id)
-    sidebar.getAndActive('nav')
+    sidebar.getAndActive(this.router, 'nav')
   }
 }
 
 export function initEvent (vm) {
   // Bind toggle button
-  sidebar.btn('button.sidebar-toggle')
+  sidebar.btn('button.sidebar-toggle', vm.router)
   // Bind sticky effect
   if (vm.config.coverpage) {
     !isMobile && on('scroll', sidebar.sticky)

src/core/event/scroll.js

@@ -1,6 +1,5 @@
 import { isMobile } from '../util/env'
 import * as dom from '../util/dom'
-import { parse } from '../route/hash'
 
 const nav = {}
 let hoverOver = false
@@ -53,7 +52,7 @@ function highlight () {
   }
 }
 
-export function scrollActiveSidebar () {
+export function scrollActiveSidebar (router) {
   if (isMobile) return
 
   const sidebar = dom.getNode('.sidebar')
@@ -66,7 +65,7 @@ export function scrollActiveSidebar () {
     let href = a.getAttribute('href')
 
     if (href !== '/') {
-      href = parse(href).query.id
+      href = router.parse(href).query.id
     }
 
     nav[decodeURIComponent(href)] = li

src/core/event/sidebar.js

@@ -1,23 +1,27 @@
 import { isMobile } from '../util/env'
 import * as dom from '../util/dom'
-import { getHash } from '../route/hash'
 
 const title = dom.$.title
 /**
  * Toggle button
  */
-export function btn (el) {
-  const toggle = () => dom.body.classList.toggle('close')
+export function btn (el, router) {
+  const toggle = _ => dom.body.classList.toggle('close')
 
   el = dom.getNode(el)
-  dom.on(el, 'click', toggle)
+  dom.on(el, 'click', e => {
+    e.stopPropagation()
+    toggle()
+  })
 
   const sidebar = dom.getNode('.sidebar')
 
-  dom.on(sidebar, 'click', () => {
-    isMobile && toggle()
-    setTimeout(() => getAndActive(sidebar, true, true), 0)
-  })
+  isMobile && dom.on(dom.body, 'click', _ =>
+    dom.body.classList.contains('close') && toggle()
+  )
+  dom.on(sidebar, 'click', _ =>
+    setTimeout((_ => getAndActive(router, sidebar, true, true), 0))
+  )
 }
 
 export function sticky () {
@@ -34,16 +38,17 @@ export function sticky () {
 
 /**
  * Get and active link
+ * @param  {object} router
  * @param  {string|element}  el
  * @param  {Boolean} isParent   acitve parent
  * @param  {Boolean} autoTitle  auto set title
  * @return {element}
  */
-export function getAndActive (el, isParent, autoTitle) {
+export function getAndActive (router, el, isParent, autoTitle) {
   el = dom.getNode(el)
 
   const links = dom.findAll(el, 'a')
-  const hash = '#' + getHash()
+  const hash = router.toURL(router.getCurrentPath())
   let target
 
   links

src/core/fetch/ajax.js

@@ -14,9 +14,10 @@ export function get (url, hasBar = false) {
   const on = function () {
     xhr.addEventListener.apply(xhr, arguments)
   }
+  const cached = cache[url]
 
-  if (cache[url]) {
-    return { then: cb => cb(cache[url]), abort: noop }
+  if (cached) {
+    return { then: cb => cb(cached.content, cached.opt), abort: noop }
   }
 
   xhr.open('GET', url)
@@ -41,8 +42,14 @@ export function get (url, hasBar = false) {
         if (target.status >= 400) {
           error(target)
         } else {
-          cache[url] = target.response
-          success(target.response)
+          const result = cache[url] = {
+            content: target.response,
+            opt: {
+              updatedAt: xhr.getResponseHeader('last-modified')
+            }
+          }
+
+          success(result.content, result.opt)
         }
       })
     },

src/core/fetch/index.js

@@ -1,7 +1,8 @@
 import { get } from './ajax'
 import { callHook } from '../init/lifecycle'
-import { getParentPath } from '../route/util'
+import { getParentPath } from '../router/util'
 import { noop } from '../util/core'
+import { getAndActive } from '../event/sidebar'
 
 function loadNested (path, file, next, vm, first) {
   path = first ? path : path.replace(/\/$/, '')
@@ -9,7 +10,7 @@ function loadNested (path, file, next, vm, first) {
 
   if (!path) return
 
-  get(vm.$getFile(path + file))
+  get(vm.router.getFile(path + file))
     .then(next, _ => loadNested(path, file, next, vm))
 }
 
@@ -22,14 +23,14 @@ export function fetchMixin (proto) {
     // Abort last request
     last && last.abort && last.abort()
 
-    last = get(this.$getFile(path), true)
+    last = get(this.router.getFile(path), true)
 
     // Current page is html
     this.isHTML = /\.html$/g.test(path)
 
     // Load main content
-    last.then(text => {
-      this._renderMain(text)
+    last.then((text, opt) => {
+      this._renderMain(text, opt)
       if (!loadSidebar) return cb()
 
       const fn = result => { this._renderSidebar(result); cb() }
@@ -47,7 +48,7 @@ export function fetchMixin (proto) {
   proto._fetchCover = function () {
     const { coverpage } = this.config
     const root = getParentPath(this.route.path)
-    const path = this.$getFile(root + coverpage)
+    const path = this.router.getFile(root + coverpage)
 
     if (this.route.path !== '/' || !coverpage) {
       this._renderCover()
@@ -70,5 +71,20 @@ export function fetchMixin (proto) {
 }
 
 export function initFetch (vm) {
-  vm.$fetch(_ => callHook(vm, 'ready'))
+  const { loadSidebar } = vm.config
+
+  // server-client renderer
+  if (vm.rendered) {
+    const activeEl = getAndActive(vm.router, '.sidebar-nav', true, true)
+    if (loadSidebar && activeEl) {
+      activeEl.parentNode.innerHTML += window.__SUB_SIDEBAR__
+    }
+    vm._bindEventOnRendered(activeEl)
+    vm._fetchCover()
+    vm.$resetEvents()
+    callHook(vm, 'doneEach')
+    callHook(vm, 'ready')
+  } else {
+    vm.$fetch(_ => callHook(vm, 'ready'))
+  }
 }

src/core/global-api.js

@@ -1,14 +1,14 @@
 import * as util from './util'
 import * as dom from './util/dom'
-import * as render from './render/compiler'
-import * as route from './route/hash'
+import { Compiler } from './render/compiler'
 import { slugify } from './render/slugify'
 import { get } from './fetch/ajax'
 import marked from 'marked'
 import prism from 'prismjs'
 
 export default function () {
-  window.Docsify = { util, dom, render, route, get, slugify }
+  window.Docsify = { util, dom, get, slugify }
+  window.DocsifyCompiler = Compiler
   window.marked = marked
   window.Prism = prism
 }

src/core/index.js

@@ -1,5 +1,5 @@
 import { initMixin } from './init'
-import { routeMixin } from './route'
+import { routerMixin } from './router'
 import { renderMixin } from './render'
 import { fetchMixin } from './fetch'
 import { eventMixin } from './event'
@@ -12,7 +12,7 @@ function Docsify () {
 const proto = Docsify.prototype
 
 initMixin(proto)
-routeMixin(proto)
+routerMixin(proto)
 renderMixin(proto)
 fetchMixin(proto)
 eventMixin(proto)

src/core/init/index.js

@@ -1,7 +1,7 @@
 import config from '../config'
 import { initLifecycle, callHook } from './lifecycle'
 import { initRender } from '../render'
-import { initRoute } from '../route'
+import { initRouter } from '../router'
 import { initEvent } from '../event'
 import { initFetch } from '../fetch'
 import { isFn } from '../util/core'
@@ -14,9 +14,9 @@ export function initMixin (proto) {
     initLifecycle(vm) // Init hooks
     initPlugin(vm) // Install plugins
     callHook(vm, 'init')
+    initRouter(vm) // Add router
     initRender(vm) // Render base DOM
     initEvent(vm) // Bind events
-    initRoute(vm) // Add hashchange eventListener
     initFetch(vm) // Fetch data
     callHook(vm, 'mounted')
   }

src/core/render/compiler.js

@@ -4,137 +4,165 @@ import { helper as helperTpl, tree as treeTpl } from './tpl'
 import { genTree } from './gen-tree'
 import { slugify } from './slugify'
 import { emojify } from './emojify'
-import { toURL, parse } from '../route/hash'
-import { getBasePath, isAbsolutePath, getPath } from '../route/util'
+import { isAbsolutePath, getPath } from '../router/util'
 import { isFn, merge, cached } from '../util/core'
 
-let markdownCompiler = marked
-let contentBase = ''
-let currentPath = ''
-let renderer = new marked.Renderer()
-const cacheTree = {}
-let toc = []
+export class Compiler {
+  constructor (config, router) {
+    this.config = config
+    this.router = router
+    this.cacheTree = {}
+    this.toc = []
+    this.linkTarget = config.externalLinkTarget || '_blank'
+    this.contentBase = router.getBasePath()
 
-/**
- * Compile markdown content
- */
-export const markdown = cached(text => {
-  let html = ''
+    const renderer = this._initRenderer()
+    let compile
+    const mdConf = config.markdown || {}
 
-  if (!text) return text
+    if (isFn(mdConf)) {
+      compile = mdConf(marked, renderer)
+    } else {
+      marked.setOptions(merge(mdConf, {
+        renderer: merge(renderer, mdConf.renderer)
+      }))
+      compile = marked
+    }
 
-  html = markdownCompiler(text)
-  html = emojify(html)
-  slugify.clear()
+    this.compile = cached(text => {
+      let html = ''
 
-  return html
-})
+      if (!text) return text
 
-markdown.renderer = renderer
+      html = compile(text)
+      html = config.noEmoji ? html : emojify(html)
+      slugify.clear()
 
-markdown.init = function (config = {}, base = window.location.pathname) {
-  contentBase = getBasePath(base)
-
-  if (isFn(config)) {
-    markdownCompiler = config(marked, renderer)
-  } else {
-    renderer = merge(renderer, config.renderer)
-    marked.setOptions(merge(config, { renderer }))
-  }
-}
-
-markdown.update = function () {
-  currentPath = parse().path
-}
-
-/**
- * render anchor tag
- * @link https://github.com/chjj/marked#overriding-renderer-methods
- */
-renderer.heading = function (text, level) {
-  const slug = slugify(text)
-  const url = toURL(currentPath, { id: slug })
-
-  toc.push({ level, slug: url, title: text })
-
-  return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${text}</span></a></h${level}>`
-}
-// highlight code
-renderer.code = function (code, lang = '') {
-  const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
-
-  return `<pre v-pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
-}
-renderer.link = function (href, title, text) {
-  let blank = ''
-  if (!/:|(\/{2})/.test(href)) {
-    href = toURL(href)
-  } else {
-    blank = ' target="_blank"'
-  }
-  if (title) {
-    title = ` title="${title}"`
-  }
-  return `<a href="${href}"${title}${blank}>${text}</a>`
-}
-renderer.paragraph = function (text) {
-  if (/^!&gt;/.test(text)) {
-    return helperTpl('tip', text)
-  } else if (/^\?&gt;/.test(text)) {
-    return helperTpl('warn', text)
-  }
-  return `<p>${text}</p>`
-}
-renderer.image = function (href, title, text) {
-  let url = href
-  const titleHTML = title ? ` title="${title}"` : ''
-
-  if (!isAbsolutePath(href)) {
-    url = getPath(contentBase, href)
+      return html
+    })
   }
 
-  return `<img src="${url}" data-origin="${href}" alt="${text}"${titleHTML}>`
-}
+  _initRenderer () {
+    const renderer = new marked.Renderer()
+    const { linkTarget, router, toc, contentBase } = this
+    /**
+     * render anchor tag
+     * @link https://github.com/chjj/marked#overriding-renderer-methods
+     */
+    renderer.heading = function (text, level) {
+      const nextToc = { level, title: text }
 
-/**
- * Compile sidebar
- */
-export function sidebar (text, level) {
-  let html = ''
+      if (/{docsify-ignore}/g.test(text)) {
+        text = text.replace('{docsify-ignore}', '')
+        nextToc.title = text
+        nextToc.ignoreSubHeading = true
+      }
 
-  if (text) {
-    html = markdown(text)
-    html = html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0]
-  } else {
-    const tree = cacheTree[currentPath] || genTree(toc, level)
-    html = treeTpl(tree, '<ul>')
-    cacheTree[currentPath] = tree
+      if (/{docsify-ignore-all}/g.test(text)) {
+        text = text.replace('{docsify-ignore-all}', '')
+        nextToc.title = text
+        nextToc.ignoreAllSubs = true
+      }
+
+      const slug = slugify(text)
+      const url = router.toURL(router.getCurrentPath(), { id: slug })
+      nextToc.slug = url
+      toc.push(nextToc)
+
+      return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${text}</span></a></h${level}>`
+    }
+    // highlight code
+    renderer.code = function (code, lang = '') {
+      const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
+
+      return `<pre v-pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
+    }
+    renderer.link = function (href, title, text) {
+      let blank = ''
+      if (!/:|(\/{2})/.test(href)) {
+        href = router.toURL(href, null, router.getCurrentPath())
+      } else {
+        blank = ` target="${linkTarget}"`
+      }
+      if (title) {
+        title = ` title="${title}"`
+      }
+      return `<a href="${href}"${title || ''}${blank}>${text}</a>`
+    }
+    renderer.paragraph = function (text) {
+      if (/^!&gt;/.test(text)) {
+        return helperTpl('tip', text)
+      } else if (/^\?&gt;/.test(text)) {
+        return helperTpl('warn', text)
+      }
+      return `<p>${text}</p>`
+    }
+    renderer.image = function (href, title, text) {
+      let url = href
+      const titleHTML = title ? ` title="${title}"` : ''
+
+      if (!isAbsolutePath(href)) {
+        url = getPath(contentBase, href)
+      }
+
+      return `<img src="${url}" data-origin="${href}" alt="${text}"${titleHTML}>`
+    }
+
+    return renderer
   }
 
-  return html
-}
+  /**
+   * Compile sidebar
+   */
+  sidebar (text, level) {
+    const currentPath = this.router.getCurrentPath()
+    let html = ''
 
-/**
- * Compile sub sidebar
- */
-export function subSidebar (el, level) {
-  if (el) {
+    if (text) {
+      html = this.compile(text)
+      html = html && html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0]
+    } else {
+      const tree = this.cacheTree[currentPath] || genTree(this.toc, level)
+      html = treeTpl(tree, '<ul>')
+      this.cacheTree[currentPath] = tree
+    }
+
+    return html
+  }
+
+  /**
+   * Compile sub sidebar
+   */
+  subSidebar (level) {
+    const currentPath = this.router.getCurrentPath()
+    const { cacheTree, toc } = this
+
+    toc[0] && toc[0].ignoreAllSubs && (this.toc = [])
     toc[0] && toc[0].level === 1 && toc.shift()
+    toc.forEach((node, i) => {
+      node.ignoreSubHeading && toc.splice(i, 1)
+    })
+
     const tree = cacheTree[currentPath] || genTree(toc, level)
-    el.parentNode.innerHTML += treeTpl(tree, '<ul class="app-sub-sidebar">')
+
     cacheTree[currentPath] = tree
+    this.toc = []
+    return treeTpl(tree, '<ul class="app-sub-sidebar">')
   }
-  toc = []
-}
 
-/**
- * Compile cover page
- */
-export function cover (text) {
-  const cacheToc = toc.slice()
-  const html = markdown(text)
+  article (text) {
+    return this.compile(text)
+  }
 
-  toc = cacheToc.slice()
+  /**
+   * Compile cover page
+   */
+  cover (text) {
+    const cacheToc = this.toc.slice()
+    const html = this.compile(text)
 
-  return html
+    this.toc = cacheToc.slice()
+
+    return html
+  }
 }

src/core/render/emojify.js

@@ -1,3 +1,5 @@
+import { inBrowser } from '../util/env'
+
 function replace (m, $1) {
   return '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' + $1 + '.png" alt="' + $1 + '" />'
 }
@@ -5,6 +7,6 @@ function replace (m, $1) {
 export function emojify (text) {
   return text
     .replace(/<(pre|template|code)[^>]*?>[\s\S]+?<\/(pre|template|code)>/g, m => m.replace(/:/g, '__colon__'))
-    .replace(/:(\w+?):/ig, window.emojify || replace)
+    .replace(/:(\w+?):/ig, (inBrowser && window.emojify) || replace)
     .replace(/__colon__/g, ':')
 }

src/core/render/index.js

@@ -1,12 +1,14 @@
 import * as dom from '../util/dom'
-import { getAndActive, sticky } from '../event/sidebar'
-import { scrollActiveSidebar, scroll2Top } from '../event/scroll'
-import cssVars from '../util/polyfill/css-vars'
 import * as tpl from './tpl'
-import { markdown, sidebar, subSidebar, cover } from './compiler'
+import cssVars from '../util/polyfill/css-vars'
+import tinydate from 'tinydate'
 import { callHook } from '../init/lifecycle'
-import { getBasePath, getPath, isAbsolutePath } from '../route/util'
+import { Compiler } from './compiler'
+import { getAndActive, sticky } from '../event/sidebar'
+import { getPath, isAbsolutePath } from '../router/util'
+import { isMobile } from '../util/env'
 import { isPrimitive } from '../util/core'
+import { scrollActiveSidebar, scroll2Top } from '../event/scroll'
 
 function executeScript () {
   const script = dom.findAll('.markdown-section>script')
@@ -20,6 +22,16 @@ function executeScript () {
   }, 0)
 }
 
+function formatUpdated (html, updated, fn) {
+  updated = typeof fn === 'function'
+    ? fn(updated)
+    : typeof fn === 'string'
+      ? tinydate(fn)(new Date(updated))
+      : updated
+
+  return html.replace(/{docsify-updated}/g, updated)
+}
+
 function renderMain (html) {
   if (!html) {
     // TODO: Custom 404 page
@@ -42,10 +54,6 @@ function renderMain (html) {
   } else {
     this.config.executeScript && executeScript()
   }
-
-  if (this.config.auto2top) {
-    scroll2Top(this.config.auto2top)
-  }
 }
 
 function renderNameLink (vm) {
@@ -58,7 +66,7 @@ function renderNameLink (vm) {
   if (isPrimitive(vm.config.nameLink)) {
     el.setAttribute('href', nameLink)
   } else if (typeof nameLink === 'object') {
-    const match = Object.keys(nameLink).find(key => path.indexOf(key) > -1)
+    const match = Object.keys(nameLink).filter(key => path.indexOf(key) > -1)[0]
 
     el.setAttribute('href', nameLink[match])
   }
@@ -71,34 +79,47 @@ export function renderMixin (proto) {
   }
 
   proto._renderSidebar = function (text) {
-    const { maxLevel, subMaxLevel, autoHeader, loadSidebar } = this.config
+    const { maxLevel, subMaxLevel, loadSidebar } = this.config
 
-    this._renderTo('.sidebar-nav', sidebar(text, maxLevel))
-    const active = getAndActive('.sidebar-nav', true, true)
-    subSidebar(loadSidebar ? active : '', subMaxLevel)
+    this._renderTo('.sidebar-nav', this.compiler.sidebar(text, maxLevel))
+    const activeEl = getAndActive(this.router, '.sidebar-nav', true, true)
+    if (loadSidebar && activeEl) {
+      activeEl.parentNode.innerHTML += this.compiler.subSidebar(subMaxLevel)
+    }
     // bind event
-    this.activeLink = active
-    scrollActiveSidebar()
+    this._bindEventOnRendered()
+  }
 
-    if (autoHeader && active) {
+  proto._bindEventOnRendered = function (activeEl) {
+    const { autoHeader, auto2top } = this.config
+
+    scrollActiveSidebar(this.router)
+
+    if (autoHeader && activeEl) {
       const main = dom.getNode('#main')
       const firstNode = main.children[0]
       if (firstNode && firstNode.tagName !== 'H1') {
         const h1 = dom.create('h1')
-        h1.innerText = active.innerText
+        h1.innerText = activeEl.innerText
         dom.before(main, h1)
       }
     }
+
+    auto2top && scroll2Top(auto2top)
   }
 
   proto._renderNav = function (text) {
-    text && this._renderTo('nav', markdown(text))
-    getAndActive('nav')
+    text && this._renderTo('nav', this.compiler.compile(text))
+    getAndActive(this.router, 'nav')
   }
 
-  proto._renderMain = function (text) {
+  proto._renderMain = function (text, opt = {}) {
     callHook(this, 'beforeEach', text, result => {
-      const html = this.isHTML ? result : markdown(result)
+      let html = this.isHTML ? result : this.compiler.compile(result)
+      if (opt.updatedAt) {
+        html = formatUpdated(html, opt.updatedAt, this.config.formatUpdated)
+      }
+
       callHook(this, 'afterEach', html, text => renderMain.call(this, text))
     })
   }
@@ -111,7 +132,7 @@ export function renderMixin (proto) {
     }
     dom.toggleClass(el, 'add', 'show')
 
-    let html = this.coverIsHTML ? text : cover(text)
+    let html = this.coverIsHTML ? text : this.compiler.cover(text)
     const m = html.trim().match('<p><img.*?data-origin="(.*?)"[^a]+alt="(.*?)">([^<]*?)</p>$')
 
     if (m) {
@@ -122,7 +143,7 @@ export function renderMixin (proto) {
 
         dom.toggleClass(el, 'add', 'has-mask')
         if (!isAbsolutePath(m[1])) {
-          path = getPath(getBasePath(this.config.basePath), m[1])
+          path = getPath(this.router.getBasePath(), m[1])
         }
         el.style.backgroundImage = `url(${path})`
         el.style.backgroundSize = 'cover'
@@ -136,7 +157,6 @@ export function renderMixin (proto) {
   }
 
   proto._updateRender = function () {
-    markdown.update()
     // render name link
     renderNameLink(this)
   }
@@ -146,35 +166,42 @@ export function initRender (vm) {
   const config = vm.config
 
   // Init markdown compiler
-  markdown.init(config.markdown, config.basePath)
+  vm.compiler = new Compiler(config, vm.router)
 
   const id = config.el || '#app'
   const navEl = dom.find('nav') || dom.create('nav')
 
-  let el = dom.find(id)
+  const el = dom.find(id)
   let html = ''
+  let navAppendToTarget = dom.body
 
-  navEl.classList.add('app-nav')
+  if (el) {
+    if (config.repo) {
+      html += tpl.corner(config.repo)
+    }
+    if (config.coverpage) {
+      html += tpl.cover()
+    }
 
-  if (!config.repo) {
-    navEl.classList.add('no-badge')
+    html += tpl.main(config)
+    // Render main app
+    vm._renderTo(el, html, true)
+  } else {
+    vm.rendered = true
   }
-  if (!el) {
-    el = dom.create(id)
-    dom.appendTo(dom.body, el)
-  }
-  if (config.repo) {
-    html += tpl.corner(config.repo)
-  }
-  if (config.coverpage) {
-    html += tpl.cover()
+
+  if (config.mergeNavbar && isMobile) {
+    navAppendToTarget = dom.find('.sidebar')
+  } else {
+    navEl.classList.add('app-nav')
+
+    if (!config.repo) {
+      navEl.classList.add('no-badge')
+    }
   }
 
-  html += tpl.main(config)
-  // Render main app
-  vm._renderTo(el, html, true)
   // Add nav
-  dom.before(dom.body, navEl)
+  dom.before(navAppendToTarget, navEl)
 
   if (config.themeColor) {
     dom.$.head.innerHTML += tpl.theme(config.themeColor)

src/core/render/tpl.js

@@ -33,12 +33,12 @@ export function main (config) {
       (config.name
         ? `<h1><a class="app-name-link" data-nosearch>${config.name}</a></h1>`
         : '') +
-      '<div class="sidebar-nav"></div>' +
+      '<div class="sidebar-nav"><!--sidebar--></div>' +
     '</aside>')
 
   return (isMobile ? `${aside}<main>` : `<main>${aside}`) +
       '<section class="content">' +
-        '<article class="markdown-section" id="main"></article>' +
+        '<article class="markdown-section" id="main"><!--main--></article>' +
       '</section>' +
     '</main>'
 }