chore: add On hold label

@anikethsaha

.eslintignore

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

.eslintrc

@@ -1,6 +1,34 @@
 {
-  "extends": ["vue"],
+  "extends": "xo-space/browser",
+  "rules": {
+    "semi": [
+      2,
+      "never"
+    ],
+    "no-return-assign": "off",
+    "no-unused-expressions": "off",
+    "no-new-func": "off",
+    "no-multi-assign": "off",
+    "no-mixed-operators": "off",
+    "max-params": "off",
+    "no-script-url": "off",
+    "camelcase": "off",
+    "object-curly-spacing": "off",
+    "no-warning-comments": "off",
+    "no-negated-condition": "off",
+    "eqeqeq": "warn",
+    "no-eq-null": "warn",
+    "max-statements-per-line": "warn"
+  },
   "globals": {
-    "XMLHttpRequest": true
+    "Docsify": true,
+    "$docsify": true,
+    "process": true
+  },
+  "env": {
+    "browser": true,
+    "amd": true,
+    "node": true,
+    "jest": true
   }
-}
+}

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+open_collective: docsify
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+<!-- Please don't delete this template or we'll close your issue -->
+<!-- Please use English language -->
+<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
+<!-- Please ask questions on StackOverflow: https://stackoverflow.com/questions/ask?tags=docsify -->
+
+## Bug Report
+
+#### Steps to reproduce
+
+
+
+#### What is current behaviour
+
+
+
+#### What is the expected behaviour
+
+
+
+#### Other relevant information
+
+<!-- (Update "[ ]" to "[x]" to check a box) -->
+- [ ] Bug does still occur when all/other plugins are disabled?
+
+- Your OS: 
+- Node.js version: 
+- npm/yarn version: 
+- Browser version: 
+- Docsify version: 
+- Docsify plugins: 
+
+<!-- Love docsify? Please consider supporting our collective:
+👉  https://opencollective.com/docsify/donate -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+<!-- Please don't delete this template or we'll close your issue -->
+<!-- Please use English language -->
+<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
+<!-- Please ask questions on StackOverflow 👉 https://stackoverflow.com/questions/ask?tags=docsify -->
+
+## Feature request
+
+#### What problem does this feature solve?
+
+
+
+#### What does the proposed API look like?
+
+
+
+#### How should this be implemented in your opinion?
+
+
+
+#### Are you willing to work on this yourself?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,54 @@
+<!-- Please use English language -->
+<!-- Please don't delete this template -->
+
+<!-- PULL REQUEST TEMPLATE -->
+<!-- (Update "[ ]" to "[x]" to check a box) -->
+
+**Summary**
+
+**What kind of change does this PR introduce?** (check at least one)
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update
+- [ ] Refactor
+- [ ] Docs
+- [ ] Build-related changes
+- [ ] Other, please describe:
+
+If changing the UI of default theme, please provide the **before/after** screenshot:
+
+**Does this PR introduce a breaking change?** (check one)
+
+- [ ] Yes
+- [ ] No
+
+If yes, please describe the impact and migration path for existing applications:
+
+**The PR fulfills these requirements:**
+
+- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
+
+You have tested in the following browsers: (Providing a detailed version will be better.)
+
+- [ ] Chrome
+- [ ] Firefox
+- [ ] Safari
+- [ ] Edge
+- [ ] IE
+
+If adding a **new feature**, the PR's description includes:
+
+- [ ] A convincing reason for adding this feature
+- [ ] Related documents have been updated
+- [ ] Related tests have been updated
+
+To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
+
+
+**Other information:**
+
+---
+
+* [ ] DO NOT include files inside `lib` directory.
+

.github/stale.yml

@@ -0,0 +1,18 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - On hold
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/CI.yml

@@ -0,0 +1,33 @@
+name: Testing the e2e test suites
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name:  bootstrap
+      run: npm run bootstrap
+    - name: Build
+      run: npm run build
+    - name: linting
+      run: npm run lint
+    - name: end to end
+      run: npm run test:e2e

.gitignore

@@ -1,4 +1,11 @@
-.DS_Store
 *.log
+.DS_Store
+.idea
 node_modules
-/themes
+themes/
+lib/
+cypress/integration/examples
+cypress/fixtures/docs
+
+# exceptions
+!.gitkeep

.npmignore

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

.travis.yml

@@ -1,6 +1,23 @@
 sudo: false
-cache:
-  directories:
-  - $HOME/.yarn-cache
 language: node_js
 node_js: stable
+node_js:
+  - '10'
+  - '8'
+  - '12'
+branches:
+  only:
+    - master
+    - develop
+cache:
+  directories:
+    - node_modules
+before_install:
+  - npm update
+install:
+  - npm install
+script:
+  - npm run build
+  - npm run test:e2e
+script:
+  - npm run lint

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true
+}

CHANGELOG.md

@@ -1,244 +1,769 @@
-## 1.7.4
-### Bug fixes
-- Fix bugs caused by the previous version
+## [4.10.2](https://github.com/docsifyjs/docsify/compare/v4.10.0...v4.10.2) (2019-12-16)
 
-## 1.7.3
-### Bug fixes
-- Add `hr` style
-- Fixed option is an empty string
 
-## 1.7.2
-### Bug fixes
-- Fix sidebar click event in mobile browser.
 
-## 1.7.1
-### Bug fixes
-- Fix sidebar style in mobile browser.
+# [4.10.0](https://github.com/docsifyjs/docsify/compare/v4.9.4...v4.10.0) (2019-12-16)
 
-## 1.7.0
 
-### Bug fixes
-- Fixed custom cover background, fixed #52
-- Fixed sticky sidebar
+### Bug Fixes
 
-## Features
-- Add `name` and `nameLink`
+* fixed security alert for chokidar(update dep) ([a62b037](https://github.com/docsifyjs/docsify/commit/a62b037becb36941c11c8eab6e4d83df8db85af3))
+* npm audit issues ([#934](https://github.com/docsifyjs/docsify/issues/934)) ([615205c](https://github.com/docsifyjs/docsify/commit/615205cfdb7aea8f37a1ec5dd928105eeef56357))
+* package security alerts ([f5f1561](https://github.com/docsifyjs/docsify/commit/f5f15619f1a239d6ce12a2f83ad8817352a3352b))
+* security alerts of cssnano ([d7d5c8f](https://github.com/docsifyjs/docsify/commit/d7d5c8f302d7c18dbb32e982202a07b73badf6f6))
 
-## 1.6.1
-### Bug fixes
-- 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>`
 
-## 1.5.2
-### Bug fixes
-- Fixed number at the beginning of the slug
+<a name="4.9.4"></a>
+## [4.9.4](https://github.com/docsifyjs/docsify/compare/v4.9.2...v4.9.4) (2019-05-05)
 
-## 1.5.1
-### Bug fixes
-- Remove HTML tag when handling slug
 
-## 1.5.0
 
-### Bug fixes
-- Fix slugify.
-- Fix nav highlight.
+<a name="4.9.2"></a>
+## [4.9.2](https://github.com/docsifyjs/docsify/compare/v4.9.1...v4.9.2) (2019-04-21)
+
+
+### Bug Fixes
+
+* re-render gitalk when router changed ([11ea1f8](https://github.com/docsifyjs/docsify/commit/11ea1f8))
+
 
 ### Features
-- Initialize the configuration by `window.$docsify`.
-- Markdown parser is configurable.
 
-## 1.4.3
-### Bug fixes
-- Tweak style.
-
-## 1.4.2
-
-### Bug fixes
-- Fix toggle button style.
-- Support `mailto`, `tel`, etc. href type
-- Fix scroll to top.
+* allows relative path, fixed [#590](https://github.com/docsifyjs/docsify/issues/590) ([31654f1](https://github.com/docsifyjs/docsify/commit/31654f1))
 
 
-## 1.4.1
-### Bug fixes
-- Fix generate slug.
 
-## 1.4.0 Happly new year 🎉
+<a name="4.9.1"></a>
+## [4.9.1](https://github.com/docsifyjs/docsify/compare/v4.9.0...v4.9.1) (2019-02-21)
+
+
+### Bug Fixes
+
+* github assets url ([#774](https://github.com/docsifyjs/docsify/issues/774)) ([140bf10](https://github.com/docsifyjs/docsify/commit/140bf10))
+
+
+
+<a name="4.9.0"></a>
+# [4.9.0](https://github.com/docsifyjs/docsify/compare/v4.8.6...v4.9.0) (2019-02-19)
+
+
+### Bug Fixes
+
+* task list rendering (Fix [#749](https://github.com/docsifyjs/docsify/issues/749)) ([#757](https://github.com/docsifyjs/docsify/issues/757)) ([69ef489](https://github.com/docsifyjs/docsify/commit/69ef489))
+* upgrade npm-run-all ([049726e](https://github.com/docsifyjs/docsify/commit/049726e))
+
+
 ### Features
-- Display TOC in the custom sidebar, `data-sub-max-level`.
-- Custom background in coverpage.
 
-### Bug fixes
-- Fix scroll highlight when Vue exist.
+* **search-plugin:** add namespace option ([#706](https://github.com/docsifyjs/docsify/issues/706)) ([28beff8](https://github.com/docsifyjs/docsify/commit/28beff8))
+* Add new theme "dolphin" ([#735](https://github.com/docsifyjs/docsify/issues/735)) ([c3345ba](https://github.com/docsifyjs/docsify/commit/c3345ba))
+* Provide code fragments feature ([#748](https://github.com/docsifyjs/docsify/issues/748)) ([1447c8a](https://github.com/docsifyjs/docsify/commit/1447c8a))
 
-## 1.3.5
-### Bug fixes
-- Fix vue
 
-## 1.3.4
-### Bug fixes
 
-- Supports [vuep](https://github.com/QingWei-Li/vuep)
+<a name="4.8.6"></a>
+## [4.8.6](https://github.com/docsifyjs/docsify/compare/v4.8.5...v4.8.6) (2018-11-12)
 
-## 1.3.3
-### Bug fixes
-- Fixed cover rendering timing
 
-## 1.3.2
+### Bug Fixes
 
-### Bug fixes
-- Fixed render link
+* IE10 compatibility ([#691](https://github.com/docsifyjs/docsify/issues/691)) ([4db8cd6](https://github.com/docsifyjs/docsify/commit/4db8cd6))
 
-## 1.3.1
 
-### Bug fixes
-- Fixed cover page style
-- Generate the correct link when rendering the article
 
-## 1.3.0
+<a name="4.8.5"></a>
+## [4.8.5](https://github.com/docsifyjs/docsify/compare/v4.8.4...v4.8.5) (2018-11-02)
+
+
+### Bug Fixes
+
+* expose version info for Docsify, fixed [#641](https://github.com/docsifyjs/docsify/issues/641) ([aa719e3](https://github.com/docsifyjs/docsify/commit/aa719e3))
+
+
+
+<a name="4.8.4"></a>
+## [4.8.4](https://github.com/docsifyjs/docsify/compare/v4.8.3...v4.8.4) (2018-11-01)
+
+
+### Bug Fixes
+
+* **cover:** Compatible with legacy styles, fixed [#677](https://github.com/docsifyjs/docsify/issues/677) ([#678](https://github.com/docsifyjs/docsify/issues/678)) ([1a945d4](https://github.com/docsifyjs/docsify/commit/1a945d4))
+
+
+
+<a name="4.8.3"></a>
+
+## [4.8.3](https://github.com/docsifyjs/docsify/compare/v4.8.2...v4.8.3) (2018-11-01)
+
+Fix the last release files has the old version marked...
+
+<a name="4.8.2"></a>
+
+## [4.8.2](https://github.com/docsifyjs/docsify/compare/v4.8.1...v4.8.2) (2018-11-01)
+
+### Bug Fixes
+
+- cover button style, fixed [#670](https://github.com/docsifyjs/docsify/issues/670), fixed [#665](https://github.com/docsifyjs/docsify/issues/665) ([#675](https://github.com/docsifyjs/docsify/issues/675)) ([fcd1087](https://github.com/docsifyjs/docsify/commit/fcd1087))
+- update match regex ([#669](https://github.com/docsifyjs/docsify/issues/669)) ([2edf47e](https://github.com/docsifyjs/docsify/commit/2edf47e))
+- use copy of cached value ([#668](https://github.com/docsifyjs/docsify/issues/668)) ([5fcf210](https://github.com/docsifyjs/docsify/commit/5fcf210))
+- **compiler:** import prism-markup-templating, fixed [#672](https://github.com/docsifyjs/docsify/issues/672) ([#676](https://github.com/docsifyjs/docsify/issues/676)) ([fdd8826](https://github.com/docsifyjs/docsify/commit/fdd8826))
+
 ### Features
-- Add cover page
-- add `<kbd>` style
-- headling can be cliked
 
-### Bug fixes
-- sidebar highlight
+- add heading config id ([#671](https://github.com/docsifyjs/docsify/issues/671)) ([ab19b13](https://github.com/docsifyjs/docsify/commit/ab19b13))
 
+<a name="4.8.1"></a>
 
-### break change
-- Navbar no longer fixed at the top
+## [4.8.1](https://github.com/docsifyjs/docsify/compare/v4.8.0...v4.8.1) (2018-10-31)
+
+### Bug Fixes
+
+- ssr package dep, fixed [#605](https://github.com/docsifyjs/docsify/issues/605) ([2bc880d](https://github.com/docsifyjs/docsify/commit/2bc880d))
+- **compiler:** extra quotes for codeblock ([4f588e0](https://github.com/docsifyjs/docsify/commit/4f588e0))
+- **compiler:** prevent render of html code in paragraph, fixed [#663](https://github.com/docsifyjs/docsify/issues/663) ([d35059d](https://github.com/docsifyjs/docsify/commit/d35059d))
 
-## 1.2.0
 ### Features
-- custom basePath
-- custom homepage
 
-## 1.1.7
-### Bug fixes
-- Optimize progress bar
+- upgrade PrismJS, fixed [#534](https://github.com/docsifyjs/docsify/issues/534) ([4805cb5](https://github.com/docsifyjs/docsify/commit/4805cb5))
+
+<a name="4.8.0"></a>
+
+# [4.8.0](https://github.com/docsifyjs/docsify/compare/v4.7.1...v4.8.0) (2018-10-31)
+
+### Bug Fixes
+
+- Cache TOC for later usage in the case of cached file html ([#649](https://github.com/docsifyjs/docsify/issues/649)) ([9e86017](https://github.com/docsifyjs/docsify/commit/9e86017))
+- improve external script plugin ([#632](https://github.com/docsifyjs/docsify/issues/632)) ([50c2434](https://github.com/docsifyjs/docsify/commit/50c2434))
+- missing variable declaration ([#660](https://github.com/docsifyjs/docsify/issues/660)) ([1ce37bd](https://github.com/docsifyjs/docsify/commit/1ce37bd))
+- Remove target for mailto links ([#652](https://github.com/docsifyjs/docsify/issues/652)) ([18f0f03](https://github.com/docsifyjs/docsify/commit/18f0f03))
+- Update getAllPath query selector ([#653](https://github.com/docsifyjs/docsify/issues/653)) ([f6f4e32](https://github.com/docsifyjs/docsify/commit/f6f4e32))
+- Update vue.styl ([#634](https://github.com/docsifyjs/docsify/issues/634)) ([bf060be](https://github.com/docsifyjs/docsify/commit/bf060be))
 
-## 1.1.6
 ### Features
-- Add logo 😂
 
-### Bug fixes
-- Remove table background color
-- Fixed highlight sidebar using chinese ids
+- Add docsify version to $window.docsify object ([#641](https://github.com/docsifyjs/docsify/issues/641)) ([94bc415](https://github.com/docsifyjs/docsify/commit/94bc415)), closes [#521](https://github.com/docsifyjs/docsify/issues/521)
+- **compiler:** support embedded mermaid ([#629](https://github.com/docsifyjs/docsify/issues/629)) ([42ea8af](https://github.com/docsifyjs/docsify/commit/42ea8af))
+- Add hideOtherSidebarContent option ([#661](https://github.com/docsifyjs/docsify/issues/661)) ([4a23c4a](https://github.com/docsifyjs/docsify/commit/4a23c4a))
+- Allow base64, external, and relative logo values ([#642](https://github.com/docsifyjs/docsify/issues/642)) ([0a0802a](https://github.com/docsifyjs/docsify/commit/0a0802a)), closes [#577](https://github.com/docsifyjs/docsify/issues/577)
+- upgrade marked to 0.5.x, fixed [#645](https://github.com/docsifyjs/docsify/issues/645), close [#644](https://github.com/docsifyjs/docsify/issues/644) ([#662](https://github.com/docsifyjs/docsify/issues/662)) ([a39b214](https://github.com/docsifyjs/docsify/commit/a39b214))
+
+<a name="4.7.1"></a>
+
+## [4.7.1](https://github.com/docsifyjs/docsify/compare/v4.7.0...v4.7.1) (2018-08-30)
+
+<a name="4.7.0"></a>
+
+# [4.7.0](https://github.com/QingWei-Li/docsify/compare/v4.6.9...v4.7.0) (2018-06-29)
+
+### Bug Fixes
+
+- alldow addition content in sidebar, fix [#518](https://github.com/QingWei-Li/docsify/issues/518), fix 539 ([#543](https://github.com/QingWei-Li/docsify/issues/543)) ([04b36b0](https://github.com/QingWei-Li/docsify/commit/04b36b0))
+- async install config, fixed [#425](https://github.com/QingWei-Li/docsify/issues/425) ([e4e011c](https://github.com/QingWei-Li/docsify/commit/e4e011c))
+- loading embed files synchronously, fixed [#525](https://github.com/QingWei-Li/docsify/issues/525), fixed [#527](https://github.com/QingWei-Li/docsify/issues/527) ([#544](https://github.com/QingWei-Li/docsify/issues/544)) ([feea7f9](https://github.com/QingWei-Li/docsify/commit/feea7f9))
+- path include chinese character cause hilight bug ([#556](https://github.com/QingWei-Li/docsify/issues/556)) ([a5f333a](https://github.com/QingWei-Li/docsify/commit/a5f333a))
 
-## 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
+- add logo option, [#264](https://github.com/QingWei-Li/docsify/issues/264) ([#541](https://github.com/QingWei-Li/docsify/issues/541)) ([ee72dd0](https://github.com/QingWei-Li/docsify/commit/ee72dd0))
+- add unpkg field, close [#531](https://github.com/QingWei-Li/docsify/issues/531) ([#558](https://github.com/QingWei-Li/docsify/issues/558)) ([5c0de0a](https://github.com/QingWei-Li/docsify/commit/5c0de0a))
+- support image resizing, resolve [#508](https://github.com/QingWei-Li/docsify/issues/508) ([#545](https://github.com/QingWei-Li/docsify/issues/545)) ([3a7ad62](https://github.com/QingWei-Li/docsify/commit/3a7ad62))
 
-## 1.1.4
-### Bug fixes
-- Fixed chinese auchor link
+<a name="4.6.10"></a>
 
-## 1.1.3
-### Bug fixes
-- Optimize progress bar again
+## [4.6.10](https://github.com/QingWei-Li/docsify/compare/v4.6.9...v4.6.10) (2018-03-25)
 
-## 1.1.2
-### Bug fixes
-- fix failed `auto2top` in mobile
+### Bug Fixes
 
+- async install config, fixed [#425](https://github.com/QingWei-Li/docsify/issues/425) ([e4e011c](https://github.com/QingWei-Li/docsify/commit/e4e011c))
 
-## 1.1.1
-### Bug fixes
-- Optimize progress bar
+<a name="4.6.9"></a>
 
-## 1.1.0
-## Features
-- Add progress bar
-- Add `auto2top` option for hash router
+## [4.6.9](https://github.com/QingWei-Li/docsify/compare/v4.6.8...v4.6.9) (2018-03-10)
 
-## 1.0.3
-### Bug fixes
-- Fix cache
+### Bug Fixes
 
-## 1.0.2
-### Bug fixes
-- Fix binding events bug, fixed #24
-- Fix regular expression, fixed #23
+- upgrade medium-zoom, fixed [#417](https://github.com/QingWei-Li/docsify/issues/417) ([6a3d69a](https://github.com/QingWei-Li/docsify/commit/6a3d69a))
 
-## 1.0.1
-### Bug fixes
-- `img` style
+<a name="4.6.8"></a>
 
-## 1.0.0
-## Features
-- Support hash router
+## [4.6.8](https://github.com/QingWei-Li/docsify/compare/v4.6.7...v4.6.8) (2018-03-06)
 
-### Bug fixes
-- Improved scrolling on mobile
+### Bug Fixes
 
-## 0.7.0
-### Breaking change
-- `themes/` was removed, only exists in the npm package.
+- resolve path of image and embed files, fixed [#412](https://github.com/QingWei-Li/docsify/issues/412) ([bfd0d18](https://github.com/QingWei-Li/docsify/commit/bfd0d18))
 
-### Bug fixes
-- Fix style.
-- Fix sidebar animation again.
+<a name="4.6.7"></a>
 
-## 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.
+## [4.6.7](https://github.com/QingWei-Li/docsify/compare/v4.6.6...v4.6.7) (2018-03-03)
+
+### Bug Fixes
+
+- layout css, fixed [#409](https://github.com/QingWei-Li/docsify/issues/409) ([aeb692e](https://github.com/QingWei-Li/docsify/commit/aeb692e))
+
+<a name="4.6.6"></a>
+
+## [4.6.6](https://github.com/QingWei-Li/docsify/compare/v4.6.5...v4.6.6) (2018-03-03)
+
+<a name="4.6.5"></a>
+
+## [4.6.5](https://github.com/QingWei-Li/docsify/compare/v4.6.4...v4.6.5) (2018-03-03)
+
+### Bug Fixes
+
+- **navbar:** Now Navbar isn't append to DOM when loadNavbar is falsy ([#407](https://github.com/QingWei-Li/docsify/issues/407)) ([0933445](https://github.com/QingWei-Li/docsify/commit/0933445))
 
-## 0.6.0
 ### Features
-- Navbar support dropdown list, #6
-- Sidebar with toggle
 
-### Bug fixes
-- Fix ineffective option, fixed #10
+- **config:** Add 404 page options. ([#406](https://github.com/QingWei-Li/docsify/issues/406)) ([9b3b445](https://github.com/QingWei-Li/docsify/commit/9b3b445))
+
+<a name="4.6.4"></a>
+
+## [4.6.4](https://github.com/QingWei-Li/docsify/compare/v4.6.3...v4.6.4) (2018-03-01)
+
+### Bug Fixes
+
+- **render:** Disable markdown parsing when the file is an HTML ([#403](https://github.com/QingWei-Li/docsify/issues/403)) ([278a75e](https://github.com/QingWei-Li/docsify/commit/278a75e))
 
-## 0.5.0
 ### Features
-- Custom sidebars and navbars by markdown file
 
-## 0.4.2
-### Bug fixes
-- Correct catch ajax error
+- **fetch:** Add fallback languages configuration. ([#402](https://github.com/QingWei-Li/docsify/issues/402)) ([ecc0e04](https://github.com/QingWei-Li/docsify/commit/ecc0e04))
 
-## 0.4.1
-### Bug fixes
-- catch ajax error
+<a name="4.6.3"></a>
+
+## [4.6.3](https://github.com/QingWei-Li/docsify/compare/v4.6.2...v4.6.3) (2018-02-15)
+
+### Bug Fixes
+
+- **hook:** beforeEach don\'t work, fixed [#393](https://github.com/QingWei-Li/docsify/issues/393) ([6a09059](https://github.com/QingWei-Li/docsify/commit/6a09059))
+
+<a name="4.6.2"></a>
+
+## [4.6.2](https://github.com/QingWei-Li/docsify/compare/v4.6.1...v4.6.2) (2018-02-14)
+
+### Bug Fixes
+
+- **embed:** broken in IE, fixed [#389](https://github.com/QingWei-Li/docsify/issues/389), fixed [#391](https://github.com/QingWei-Li/docsify/issues/391) ([45a7464](https://github.com/QingWei-Li/docsify/commit/45a7464))
+- **embed:** init value ([890a7bf](https://github.com/QingWei-Li/docsify/commit/890a7bf))
+
+<a name="4.6.1"></a>
+
+## [4.6.1](https://github.com/QingWei-Li/docsify/compare/v4.6.0...v4.6.1) (2018-02-12)
+
+### Bug Fixes
+
+- **embed** compatible ssr ([dc0c3ce](https://github.com/QingWei-Li/docsify/commit/dc0c3ce))
+- **embed** async fetch embed files, fixed [#387](https://github.com/QingWei-Li/docsify/issues/387)
+
+<a name="4.6.0"></a>
+
+# [4.6.0](https://github.com/QingWei-Li/docsify/compare/v4.5.9...v4.6.0) (2018-02-11)
+
+### Bug Fixes
+
+- **search:** custom clear button, fixed [#271](https://github.com/QingWei-Li/docsify/issues/271) ([864aa18](https://github.com/QingWei-Li/docsify/commit/864aa18))
+- **search:** escape special characters for search, fixed [#369](https://github.com/QingWei-Li/docsify/issues/369) ([9755439](https://github.com/QingWei-Li/docsify/commit/9755439))
+- build config ([342438f](https://github.com/QingWei-Li/docsify/commit/342438f))
+- button style for coverpage, fixed [#362](https://github.com/QingWei-Li/docsify/issues/362) ([85428ef](https://github.com/QingWei-Li/docsify/commit/85428ef))
+- dropdown scroll style, fixed [#346](https://github.com/QingWei-Li/docsify/issues/346) ([c4d83f2](https://github.com/QingWei-Li/docsify/commit/c4d83f2))
+- highlight homepage link, fixed [#304](https://github.com/QingWei-Li/docsify/issues/304) ([f960c19](https://github.com/QingWei-Li/docsify/commit/f960c19))
+- homepage link ([e097f88](https://github.com/QingWei-Li/docsify/commit/e097f88))
+- onlyCover ([033be4f](https://github.com/QingWei-Li/docsify/commit/033be4f))
+- ssr compatible embedd ([ebc10c4](https://github.com/QingWei-Li/docsify/commit/ebc10c4))
+- ssr coverpage, fixed [#273](https://github.com/QingWei-Li/docsify/issues/273) ([9e824a4](https://github.com/QingWei-Li/docsify/commit/9e824a4))
 
-## 0.4.0
 ### Features
-- Custom sidebar
 
-### Bug fixes
-- Fix undefined language
+- click sidebar menu add collapse and expand, close [#294](https://github.com/QingWei-Li/docsify/issues/294) ([5e161a1](https://github.com/QingWei-Li/docsify/commit/5e161a1))
+- **compiler:** support embedded file as code block, close [#134](https://github.com/QingWei-Li/docsify/issues/134) ([761ccc2](https://github.com/QingWei-Li/docsify/commit/761ccc2))
+- **compiler:** support embedded markdown, html, video, etc files, close [#383](https://github.com/QingWei-Li/docsify/issues/383), close [#333](https://github.com/QingWei-Li/docsify/issues/333) ([524f52f](https://github.com/QingWei-Li/docsify/commit/524f52f))
+- **cover:** add onlyCover option, close [#382](https://github.com/QingWei-Li/docsify/issues/382) ([b265fdd](https://github.com/QingWei-Li/docsify/commit/b265fdd))
+- **fetch:** add requestHeaders option, fixed [#336](https://github.com/QingWei-Li/docsify/issues/336) ([54ab4c9](https://github.com/QingWei-Li/docsify/commit/54ab4c9))
+- **render:** add ext option for custom file extenstion, close [#340](https://github.com/QingWei-Li/docsify/issues/340) ([248aa72](https://github.com/QingWei-Li/docsify/commit/248aa72))
+- **render:** mutilple coverpage, close [#315](https://github.com/QingWei-Li/docsify/issues/315) ([f68ddf5](https://github.com/QingWei-Li/docsify/commit/f68ddf5))
 
-## 0.3.1
-### Bug fixes
-- Strip HTML tag when rendering the headings
+<a name="4.5.9"></a>
+
+## [4.5.9](https://github.com/QingWei-Li/docsify/compare/v4.5.8...v4.5.9) (2018-02-07)
+
+### Bug Fixes
+
+- upgrade marked ([4157173](https://github.com/QingWei-Li/docsify/commit/4157173))
+
+<a name="4.5.8"></a>
+
+## [4.5.8](https://github.com/QingWei-Li/docsify/compare/v4.5.6...v4.5.8) (2018-02-07)
+
+### Bug Fixes
+
+- cover style, fixed [#381](https://github.com/QingWei-Li/docsify/issues/381) ([368754e](https://github.com/QingWei-Li/docsify/commit/368754e))
+- updated deps ([#337](https://github.com/QingWei-Li/docsify/issues/337)) ([a12d393](https://github.com/QingWei-Li/docsify/commit/a12d393))
+
+<a name="4.5.7"></a>
+
+## [4.5.7](https://github.com/QingWei-Li/docsify/compare/v4.5.6...v4.5.7) (2017-12-29)
 
-## 0.3.0
 ### Features
-- Add minified css files
-- Add max level option
-- Add pure.css
 
-## 0.2.1
-### Bug fixes
-- Fix vue.css
+- add navigation plugin, closed [#180](https://github.com/QingWei-Li/docsify/issues/180) ([f78be4c](https://github.com/QingWei-Li/docsify/commit/f78be4c))
 
-## 0.2.0
-### Bug fixes
-- Fix route
-- Remove dynamic title
+<a name="4.5.6"></a>
+
+## [4.5.6](https://github.com/QingWei-Li/docsify/compare/v4.5.3...v4.5.6) (2017-12-14)
+
+### Bug Fixes
+
+- **style:** increase the tap targets of menu button, fixed [#325](https://github.com/QingWei-Li/docsify/issues/325) ([888f217](https://github.com/QingWei-Li/docsify/commit/888f217))
+
+<a name="4.5.5"></a>
+
+## [4.5.5](https://github.com/QingWei-Li/docsify/compare/v4.5.4...v4.5.5) (2017-11-30)
+
+### Bug Fixes
+
+- disqus plugin issue ([#318](https://github.com/QingWei-Li/docsify/issues/318)) ([041b33e](https://github.com/QingWei-Li/docsify/commit/041b33e)), closes [#317](https://github.com/QingWei-Li/docsify/issues/317)
+
+<a name="4.5.4"></a>
+
+## [4.5.4](https://github.com/QingWei-Li/docsify/compare/v4.5.2...v4.5.4) (2017-11-29)
+
+### Bug Fixes
+
+- **compiler:** task lists style, fixed [#215](https://github.com/QingWei-Li/docsify/issues/215) ([e43ded4](https://github.com/QingWei-Li/docsify/commit/e43ded4))
 
-## 0.1.0
 ### Features
-- Add buble.css
+
+- add gitalk plugin ([#306](https://github.com/QingWei-Li/docsify/issues/306)) ([9208e64](https://github.com/QingWei-Li/docsify/commit/9208e64))
+
+<a name="4.5.3"></a>
+
+## [4.5.3](https://github.com/QingWei-Li/docsify/compare/v4.5.2...v4.5.3) (2017-11-11)
+
+### Features
+
+- add gitalk plugin ([#306](https://github.com/QingWei-Li/docsify/issues/306)) ([9208e64](https://github.com/QingWei-Li/docsify/commit/9208e64))
+
+<a name="4.5.2"></a>
+
+## [4.5.2](https://github.com/QingWei-Li/docsify/compare/v4.5.1...v4.5.2) (2017-11-09)
+
+### Features
+
+- github task lists, close [#215](https://github.com/QingWei-Li/docsify/issues/215) ([#305](https://github.com/QingWei-Li/docsify/issues/305)) ([d486eef](https://github.com/QingWei-Li/docsify/commit/d486eef))
+
+<a name="4.5.1"></a>
+
+## [4.5.1](https://github.com/QingWei-Li/docsify/compare/v4.5.0...v4.5.1) (2017-11-07)
+
+### Features
+
+- fetch files with the query params, fixed [#303](https://github.com/QingWei-Li/docsify/issues/303) ([2a2ed96](https://github.com/QingWei-Li/docsify/commit/2a2ed96))
+
+<a name="4.5.0"></a>
+
+# [4.5.0](https://github.com/QingWei-Li/docsify/compare/v4.4.1...v4.5.0) (2017-11-04)
+
+### Features
+
+- add disqus plugin, closed [#123](https://github.com/QingWei-Li/docsify/issues/123) ([fd7d4e0](https://github.com/QingWei-Li/docsify/commit/fd7d4e0))
+
+<a name="4.4.1"></a>
+
+## [4.4.1](https://github.com/QingWei-Li/docsify/compare/v4.4.0...v4.4.1) (2017-10-31)
+
+### Bug Fixes
+
+- {docsify-ignore-all} and {docsify-ignore} bug ([#299](https://github.com/QingWei-Li/docsify/issues/299)) ([cc98f56](https://github.com/QingWei-Li/docsify/commit/cc98f56))
+- zoom image plugin issue, fixed [#187](https://github.com/QingWei-Li/docsify/issues/187) ([#300](https://github.com/QingWei-Li/docsify/issues/300)) ([fa772cf](https://github.com/QingWei-Li/docsify/commit/fa772cf))
+
+<a name="4.4.0"></a>
+
+# [4.4.0](https://github.com/QingWei-Li/docsify/compare/v4.3.15...v4.4.0) (2017-10-30)
+
+### Bug Fixes
+
+- sidebar style issue on firefox, fixed [#184](https://github.com/QingWei-Li/docsify/issues/184) ([#297](https://github.com/QingWei-Li/docsify/issues/297)) ([36bfc9d](https://github.com/QingWei-Li/docsify/commit/36bfc9d))
+
+### Features
+
+- add helper for disabled link, fixed [#295](https://github.com/QingWei-Li/docsify/issues/295) ([#296](https://github.com/QingWei-Li/docsify/issues/296)) ([4ad96f3](https://github.com/QingWei-Li/docsify/commit/4ad96f3))
+
+<a name="4.3.15"></a>
+
+## [4.3.15](https://github.com/QingWei-Li/docsify/compare/v4.3.14...v4.3.15) (2017-10-20)
+
+### Bug Fixes
+
+- scroll active sidebar ([a2b8eae](https://github.com/QingWei-Li/docsify/commit/a2b8eae))
+
+<a name="4.3.14"></a>
+
+## [4.3.14](https://github.com/QingWei-Li/docsify/compare/v4.3.13...v4.3.14) (2017-10-20)
+
+### Bug Fixes
+
+- codesponsor style ([ab68268](https://github.com/QingWei-Li/docsify/commit/ab68268))
+
+<a name="4.3.13"></a>
+
+## [4.3.13](https://github.com/QingWei-Li/docsify/compare/v4.3.12...v4.3.13) (2017-10-17)
+
+### Bug Fixes
+
+- duplicate results in search fixed [#257](https://github.com/QingWei-Li/docsify/issues/257) ([#284](https://github.com/QingWei-Li/docsify/issues/284)) ([3476f6f](https://github.com/QingWei-Li/docsify/commit/3476f6f))
+
+### Features
+
+- make whole search result clickable ([#285](https://github.com/QingWei-Li/docsify/issues/285)) ([1b91227](https://github.com/QingWei-Li/docsify/commit/1b91227))
+
+<a name="4.3.12"></a>
+
+## [4.3.12](https://github.com/QingWei-Li/docsify/compare/v4.3.11...v4.3.12) (2017-10-15)
+
+### Bug Fixes
+
+- incorrect active link ([#281](https://github.com/QingWei-Li/docsify/issues/281)) ([a3ab379](https://github.com/QingWei-Li/docsify/commit/a3ab379))
+
+<a name="4.3.11"></a>
+
+## [4.3.11](https://github.com/QingWei-Li/docsify/compare/v4.3.10...v4.3.11) (2017-10-15)
+
+### Bug Fixes
+
+- broken links to same page heading, fix [#278](https://github.com/QingWei-Li/docsify/issues/278), fix [#279](https://github.com/QingWei-Li/docsify/issues/279) ([91d6337](https://github.com/QingWei-Li/docsify/commit/91d6337))
+
+<a name="4.3.10"></a>
+
+## [4.3.10](https://github.com/QingWei-Li/docsify/compare/v4.3.9...v4.3.10) (2017-10-12)
+
+### Bug Fixes
+
+- link render issue after page refreshing ([#276](https://github.com/QingWei-Li/docsify/issues/276)) ([abd885e](https://github.com/QingWei-Li/docsify/commit/abd885e))
+
+<a name="4.3.9"></a>
+
+## [4.3.9](https://github.com/QingWei-Li/docsify/compare/v4.3.8...v4.3.9) (2017-10-11)
+
+### Bug Fixes
+
+- scroll issue in IE ([#275](https://github.com/QingWei-Li/docsify/issues/275)) ([3e94cb6](https://github.com/QingWei-Li/docsify/commit/3e94cb6))
+
+<a name="4.3.8"></a>
+
+## [4.3.8](https://github.com/QingWei-Li/docsify/compare/v4.3.7...v4.3.8) (2017-10-07)
+
+### Bug Fixes
+
+- **slugify:** GitHub compatible heading links, fixed [#272](https://github.com/QingWei-Li/docsify/issues/272) ([9b4e666](https://github.com/QingWei-Li/docsify/commit/9b4e666))
+
+<a name="4.3.7"></a>
+
+## [4.3.7](https://github.com/QingWei-Li/docsify/compare/v4.3.6...v4.3.7) (2017-10-02)
+
+### Bug Fixes
+
+- **slugify:** GitHub compatible heading links, fixed [#267](https://github.com/QingWei-Li/docsify/issues/267) ([c195d2d](https://github.com/QingWei-Li/docsify/commit/c195d2d))
+
+<a name="4.3.6"></a>
+
+## [4.3.6](https://github.com/QingWei-Li/docsify/compare/v4.3.5...v4.3.6) (2017-09-21)
+
+### Bug Fixes
+
+- style for codesponsor plugin ([08afec7](https://github.com/QingWei-Li/docsify/commit/08afec7))
+
+<a name="4.3.5"></a>
+
+## [4.3.5](https://github.com/QingWei-Li/docsify/compare/v4.3.4...v4.3.5) (2017-09-20)
+
+### Bug Fixes
+
+- missed symbol ([#254](https://github.com/QingWei-Li/docsify/issues/254)) ([6c702d3](https://github.com/QingWei-Li/docsify/commit/6c702d3))
+
+### Features
+
+- **plugin:** add codesponsor plugin ([46ac4c3](https://github.com/QingWei-Li/docsify/commit/46ac4c3))
+
+<a name="4.3.4"></a>
+
+## [4.3.4](https://github.com/QingWei-Li/docsify/compare/v4.3.3...v4.3.4) (2017-09-07)
+
+### Bug Fixes
+
+- scroll position issue, fixed [#234](https://github.com/QingWei-Li/docsify/issues/234) ([388ed3d](https://github.com/QingWei-Li/docsify/commit/388ed3d))
+
+<a name="4.3.3"></a>
+
+## [4.3.3](https://github.com/QingWei-Li/docsify/compare/v4.3.2...v4.3.3) (2017-09-06)
+
+### Bug Fixes
+
+- **buble.css:** tweaks code block style, fixed [#249](https://github.com/QingWei-Li/docsify/issues/249) ([9d43051](https://github.com/QingWei-Li/docsify/commit/9d43051))
+
+### Features
+
+- add doc for react and vue demo box plugin ([#247](https://github.com/QingWei-Li/docsify/issues/247)) ([f0aca19](https://github.com/QingWei-Li/docsify/commit/f0aca19))
+
+<a name="4.3.2"></a>
+
+## [4.3.2](https://github.com/QingWei-Li/docsify/compare/v4.3.1...v4.3.2) (2017-09-01)
+
+### Bug Fixes
+
+- sidebar highlight ([f82f419](https://github.com/QingWei-Li/docsify/commit/f82f419))
+
+### Features
+
+- add Edit on github plugin (thanks [@njleonzhang](https://github.com/njleonzhang)) ([a0e1ea8](https://github.com/QingWei-Li/docsify/commit/a0e1ea8))
+
+<a name="4.3.1"></a>
+
+## [4.3.1](https://github.com/QingWei-Li/docsify/compare/v4.2.9...v4.3.1) (2017-08-30)
+
+### Features
+
+- **markdown:** supports mermaid [#137](https://github.com/QingWei-Li/docsify/issues/137) ([f4800e0](https://github.com/QingWei-Li/docsify/commit/f4800e0))
+
+<a name="4.3.0"></a>
+
+# [4.3.0](https://github.com/QingWei-Li/docsify/compare/v4.2.9...v4.3.0) (2017-08-17)
+
+### Features
+
+- **markdown:** supports mermaid [#137](https://github.com/QingWei-Li/docsify/issues/137) ([f4800e0](https://github.com/QingWei-Li/docsify/commit/f4800e0))
+
+<a name="4.2.9"></a>
+
+## [4.2.9](https://github.com/QingWei-Li/docsify/compare/v4.2.8...v4.2.9) (2017-08-15)
+
+### Bug Fixes
+
+- ensure document ready before init Docsify [#233](https://github.com/QingWei-Li/docsify/issues/233)
+
+<a name="4.2.8"></a>
+
+## [4.2.8](https://github.com/QingWei-Li/docsify/compare/v4.2.7...v4.2.8) (2017-08-10)
+
+### Features
+
+- **compiler:** support for setting target attribute for link, fixed [#230](https://github.com/QingWei-Li/docsify/issues/230) ([7f270f9](https://github.com/QingWei-Li/docsify/commit/7f270f9))
+
+<a name="4.2.7"></a>
+
+## [4.2.7](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.7) (2017-08-05)
+
+### Bug Fixes
+
+- **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+- **style:** nowrap => pre-wrap, fixed [#228](https://github.com/QingWei-Li/docsify/issues/228) ([a88252c](https://github.com/QingWei-Li/docsify/commit/a88252c))
+
+<a name="4.2.6"></a>
+
+## [4.2.6](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.6) (2017-07-27)
+
+### Bug Fixes
+
+- **css:** hide the nav when the content has not yet been loaded ([1fa1619](https://github.com/QingWei-Li/docsify/commit/1fa1619))
+- **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+
+<a name="4.2.4"></a>
+
+## [4.2.4](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.4) (2017-07-26)
+
+### Bug Fixes
+
+- **render:** Remove getRootNode to be compatible with the lower version of Chrome, fixed [#225](https://github.com/QingWei-Li/docsify/issues/225) ([b8dd346](https://github.com/QingWei-Li/docsify/commit/b8dd346))
+
+<a name="4.2.3"></a>
+
+## [4.2.3](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.3) (2017-07-26)
+
+### Features
+
+- **search:** Supports the max depth of the search headline, fixed [#223](https://github.com/QingWei-Li/docsify/issues/223), resolve [#129](https://github.com/QingWei-Li/docsify/issues/129) ([b7b589b](https://github.com/QingWei-Li/docsify/commit/b7b589b))
+
+<a name="4.2.2"></a>
+
+## [4.2.2](https://github.com/QingWei-Li/docsify/compare/v4.2.1...v4.2.2) (2017-07-24)
+
+### Bug Fixes
+
+- style rerender due to setting themeColor ([17ff3d1](https://github.com/QingWei-Li/docsify/commit/17ff3d1))
+
+<a name="4.2.1"></a>
+
+## [4.2.1](https://github.com/QingWei-Li/docsify/compare/v4.2.0...v4.2.1) (2017-07-19)
+
+- give the navbar some line-height (#216)
+- Remove unnecessary moduleName option from rollup config for plugins (#209)
+
+<a name="4.2.0"></a>
+
+# [4.2.0](https://github.com/QingWei-Li/docsify/compare/v4.1.14...v4.2.0) (2017-07-10)
+
+### Bug Fixes
+
+- not found page ([9af8559](https://github.com/QingWei-Li/docsify/commit/9af8559))
+
+### Features
+
+- alias option supports regexp, resolve [#183](https://github.com/QingWei-Li/docsify/issues/183) ([c4aa22c](https://github.com/QingWei-Li/docsify/commit/c4aa22c))
+- ignore to compiled link, fixed [#203](https://github.com/QingWei-Li/docsify/issues/203) ([#204](https://github.com/QingWei-Li/docsify/issues/204)) ([2e00f4c](https://github.com/QingWei-Li/docsify/commit/2e00f4c))
+
+<a name="4.1.14"></a>
+
+## [4.1.14](https://github.com/QingWei-Li/docsify/compare/v4.1.13...v4.1.14) (2017-06-24)
+
+### Bug Fixes
+
+- get file path, fixed jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070 ([e8117e5](https://github.com/QingWei-Li/docsify/commit/e8117e5)), closes [jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070](https://github.com/jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13/issues/commitcomment-22427070)
+
+### Features
+
+- add context attribute, fixed [#191](https://github.com/QingWei-Li/docsify/issues/191) ([ce0e9ac](https://github.com/QingWei-Li/docsify/commit/ce0e9ac))
+
+<a name="4.1.13"></a>
+
+## [4.1.13](https://github.com/QingWei-Li/docsify/compare/v4.1.12...v4.1.13) (2017-06-11)
+
+<a name="4.1.12"></a>
+
+## [4.1.12](https://github.com/QingWei-Li/docsify/compare/v4.1.11...v4.1.12) (2017-06-03)
+
+### Bug Fixes
+
+- **render:** subtitle in side bar shows undefined, fixed [#182](https://github.com/QingWei-Li/docsify/issues/182) ([d087d57](https://github.com/QingWei-Li/docsify/commit/d087d57))
+
+<a name="4.1.11"></a>
+
+## [4.1.11](https://github.com/QingWei-Li/docsify/compare/v4.1.10...v4.1.11) (2017-06-02)
+
+### Bug Fixes
+
+- **compiler:** force reset toc when rendering sidebar fixed [#181](https://github.com/QingWei-Li/docsify/issues/181) ([ccf4c7c](https://github.com/QingWei-Li/docsify/commit/ccf4c7c))
+- **render:** autoHeader does not work ([1304d2e](https://github.com/QingWei-Li/docsify/commit/1304d2e))
+
+<a name="4.1.10"></a>
+
+## [4.1.10](https://github.com/QingWei-Li/docsify/compare/v4.1.9...v4.1.10) (2017-06-02)
+
+### Bug Fixes
+
+- **hash:** hash routing crashes when url has querystring ([6d48ce1](https://github.com/QingWei-Li/docsify/commit/6d48ce1))
+
+<a name="4.1.9"></a>
+
+## [4.1.9](https://github.com/QingWei-Li/docsify/compare/v4.1.8...v4.1.9) (2017-05-31)
+
+### Bug Fixes
+
+- can't render toc on first load ([d9b487e](https://github.com/QingWei-Li/docsify/commit/d9b487e))
+- **lifecycle:** continue to handle data ([955d3d5](https://github.com/QingWei-Li/docsify/commit/955d3d5))
+- **render:** broken name link, fixed [#167](https://github.com/QingWei-Li/docsify/issues/167) ([91b66a5](https://github.com/QingWei-Li/docsify/commit/91b66a5))
+
+<a name="4.1.8"></a>
+
+## [4.1.8](https://github.com/QingWei-Li/docsify/compare/v4.1.7...v4.1.8) (2017-05-31)
+
+### Bug Fixes
+
+- auto replace version ([22b50f0](https://github.com/QingWei-Li/docsify/commit/22b50f0))
+- update edit button demo ([ec887c1](https://github.com/QingWei-Li/docsify/commit/ec887c1))
+
+### Features
+
+- add edit button demo ([a64cee1](https://github.com/QingWei-Li/docsify/commit/a64cee1))
+- add edit button demo, close [#162](https://github.com/QingWei-Li/docsify/issues/162) ([036fdac](https://github.com/QingWei-Li/docsify/commit/036fdac))
+
+<a name="4.1.7"></a>
+
+## [4.1.7](https://github.com/QingWei-Li/docsify/compare/v4.1.6...v4.1.7) (2017-05-30)
+
+### Bug Fixes
+
+- **ssr:** clean files ([0014895](https://github.com/QingWei-Li/docsify/commit/0014895))
+
+<a name="4.1.6"></a>
+
+## [4.1.6](https://github.com/QingWei-Li/docsify/compare/v4.1.5...v4.1.6) (2017-05-30)
+
+### Bug Fixes
+
+- **ssr:** add debug ([6b9e092](https://github.com/QingWei-Li/docsify/commit/6b9e092))
+
+<a name="4.1.5"></a>
+
+## [4.1.5](https://github.com/QingWei-Li/docsify/compare/v4.1.4...v4.1.5) (2017-05-30)
+
+### Bug Fixes
+
+- **ssr:** missing package ([6db8c9e](https://github.com/QingWei-Li/docsify/commit/6db8c9e))
+
+<a name="4.1.4"></a>
+
+## [4.1.4](https://github.com/QingWei-Li/docsify/compare/v4.1.3...v4.1.4) (2017-05-30)
+
+### Bug Fixes
+
+- **ssr:** file path ([79a83bc](https://github.com/QingWei-Li/docsify/commit/79a83bc))
+
+<a name="4.1.3"></a>
+
+## [4.1.3](https://github.com/QingWei-Li/docsify/compare/v4.1.2...v4.1.3) (2017-05-30)
+
+### Bug Fixes
+
+- update babel config ([9825db4](https://github.com/QingWei-Li/docsify/commit/9825db4))
+
+<a name="4.1.2"></a>
+
+## [4.1.2](https://github.com/QingWei-Li/docsify/compare/v4.1.1...v4.1.2) (2017-05-30)
+
+### Bug Fixes
+
+- update babel config ([80dba19](https://github.com/QingWei-Li/docsify/commit/80dba19))
+
+<a name="4.1.1"></a>
+
+## [4.1.1](https://github.com/QingWei-Li/docsify/compare/v4.1.0...v4.1.1) (2017-05-30)
+
+### Bug Fixes
+
+- build for ssr package ([4cb20a5](https://github.com/QingWei-Li/docsify/commit/4cb20a5))
+- remove history mode ([0e74e6c](https://github.com/QingWei-Li/docsify/commit/0e74e6c))
+
+<a name="4.1.0"></a>
+
+# [4.1.0](https://github.com/QingWei-Li/docsify/compare/v4.0.2...v4.1.0) (2017-05-30)
+
+<a name="4.0.2"></a>
+
+## [4.0.2](https://github.com/QingWei-Li/docsify/compare/v4.0.1...v4.0.2) (2017-05-30)
+
+### Bug Fixes
+
+- basePath for history mode ([fc1cd3f](https://github.com/QingWei-Li/docsify/commit/fc1cd3f))
+
+<a name="4.0.1"></a>
+
+## [4.0.1](https://github.com/QingWei-Li/docsify/compare/v4.0.0...v4.0.1) (2017-05-29)
+
+### Bug Fixes
+
+- **ssr:** remove context ([4626157](https://github.com/QingWei-Li/docsify/commit/4626157))
+- lint ([b764b6e](https://github.com/QingWei-Li/docsify/commit/b764b6e))
+
+<a name="4.0.0"></a>
+
+# [4.0.0](https://github.com/QingWei-Li/docsify/compare/v3.7.3...v4.0.0) (2017-05-29)
+
+### Bug Fixes
+
+- **render:** init event in ssr ([eba1c98](https://github.com/QingWei-Li/docsify/commit/eba1c98))
+- lint ([1f4514d](https://github.com/QingWei-Li/docsify/commit/1f4514d))
+
+### Features
+
+- finish ssr ([3444884](https://github.com/QingWei-Li/docsify/commit/3444884))
+- init ocsify-server-renderer ([6dea685](https://github.com/QingWei-Li/docsify/commit/6dea685))
+- support history mode ([f095eb8](https://github.com/QingWei-Li/docsify/commit/f095eb8))

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contribute
+
+## Introduction
+
+First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! 😊
+
+We welcome any type of contribution, not only code. You can help with 
+- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
+- **Marketing**: writing blog posts, howto's, printing stickers, ...
+- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
+- **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
+- **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify).
+
+## Your First Contribution
+
+Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
+
+## Submitting code
+
+Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
+
+## Code review process
+
+The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
+It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
+
+## Financial contributions
+
+We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify).
+Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
+
+## Questions
+
+If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
+You can also reach us at hello@docsify.opencollective.com.
+
+## Credits
+
+### Contributors
+
+Thank you to all the people who have already contributed to docsify!
+<a href="graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
+
+
+### Backers
+
+Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#backer)]
+
+<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
+
+
+### Sponsors
+
+Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
+
+<a href="https://opencollective.com/docsify/sponsor/0/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/1/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/2/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/3/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/4/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/5/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/6/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/7/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/8/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/sponsor/9/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/9/avatar.svg"></a>
+
+<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->

HISTORY.md

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

LICENSE

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

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://docsify.js.org">
-    <img alt="docsify" src="./media/docsify.png">
+    <img alt="docsify" src="./docs/_media/icon.svg">
   </a>
 </p>
 
@@ -9,54 +9,60 @@
 </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="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
+  <a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
+  <a href="https://travis-ci.org/docsifyjs/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/docsifyjs/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/vuejs/vue"><img alt="code style" src="https://img.shields.io/badge/code%20style-vue-orange.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>
+  <a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
+</p>
+
+<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
+
+<p align="center">
+  <a href="https://opencollective.com/docsify/order/3254">
+    <img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
+  </a>
 </p>
 
 ## Links
+
+- [`develop` branch preview](https://docsifyjs.netlify.com/)
 - [Documentation](https://docsify.js.org)
-- [CLI](https://github.com/QingWei-Li/docsify-cli)
+- [CLI](https://github.com/docsifyjs/docsify-cli)
+- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
+- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
+- [Community chat](https://gitter.im/docsifyjs/Lobby)
 
 ## Features
-- Simple and lightweight (~13kB gzipped)
+
+- No statically built html files
+- Simple and lightweight (~21kB gzipped)
+- Smart full-text search plugin
 - Multiple themes
-- Not build static html files
+- Useful plugin API
+- Compatible with IE11
+- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
+- Support embedded files
 
 ## Quick start
-Create a `index.html` and using `hash router`.
 
-index.html
+Look at [this tutorial](https://docsify.js.org/#/quickstart)
 
-```html
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-</body>
-<script src="//unpkg.com/docsify" data-router></script>
-</html>
-```
-
-## CDN
-- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
-- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
+[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
 
 ## Showcase
-These open-source projects are using docsify to generate their sites. Pull requests welcome : )
 
-- [docsify](https://docsify.js.org) - A magical documentation site generator.
-- [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
-- [puck](https://puck.zz173.com/) - A small & magical php framework.
-- [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency.
+These projects are using docsify to generate their sites. Pull requests welcome :blush:
+
+Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
 
 ## 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
 
@@ -64,25 +70,42 @@ These open-source projects are using docsify to generate their sites. Pull reque
 - Create your feature branch: `git checkout -b my-new-feature`
 - Commit your changes: `git commit -am 'Add some feature'`
 - Push to the branch: `git push origin my-new-feature`
-- Submit a pull request :D
-
+- Submit a pull request
 
 ## Development
 
-### prepare
 ```bash
-npm i && npm run dev
-open http://localhost:3000
+npm run bootstrap && npm run dev
 ```
 
-### More Language Highlight
+## Backers
 
-```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>
-```
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]
+
+<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)]
+
+<a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a>
+<a href="https://opencollective.com/docsify/silver-sponsors/9/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/9/avatar.svg"></a>
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
 
 ## License
-MIT
 
+[MIT](LICENSE)
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)

app.js

@@ -1,12 +0,0 @@
-var serveStatic = require('serve-static')
-var http = require('http')
-var fs = require('fs')
-
-http.createServer(function (req, res) {
-  serveStatic('.')(req, res, function () {
-    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-css.js

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

build/build.js

@@ -1,37 +1,119 @@
-var rollup = require('rollup')
-var buble = require('rollup-plugin-buble')
-var commonjs = require('rollup-plugin-commonjs')
-var nodeResolve = require('rollup-plugin-node-resolve')
-var uglify = require('rollup-plugin-uglify')
+const rollup = require('rollup')
+const buble = require('rollup-plugin-buble')
+const commonjs = require('rollup-plugin-commonjs')
+const nodeResolve = require('rollup-plugin-node-resolve')
+const { uglify } = require('rollup-plugin-uglify')
+const replace = require('rollup-plugin-replace')
+const isProd = process.env.NODE_ENV === 'production'
+const version = process.env.VERSION || require('../package.json').version
+const chokidar = require('chokidar')
+const path = require('path')
 
-var build = function (opts) {
+const build = function (opts) {
   rollup
     .rollup({
-      entry: 'src/' + opts.entry,
-      plugins: [buble()].concat(opts.plugins || [])
+      input: opts.input,
+      plugins: (opts.plugins || []).concat([
+        buble(),
+        commonjs(),
+        nodeResolve(),
+        replace({
+          __VERSION__: version,
+          'process.env.SSR': false
+        })
+      ])
     })
     .then(function (bundle) {
-      var dest = 'lib/' + (opts.output || opts.entry)
+      var dest = 'lib/' + (opts.output || opts.input)
 
       console.log(dest)
       bundle.write({
         format: 'iife',
-        moduleName: opts.moduleName || 'Docsify',
-        dest: dest
+        file: dest,
+        strict: false
       })
     })
     .catch(function (err) {
       console.error(err)
     })
 }
+const buildCore = function () {
+  build({
+    input: 'src/core/index.js',
+    output: 'docsify.js'
+  })
 
-build({
-  entry: 'index.js',
-  output: 'docsify.js',
-  plugins: [commonjs(), nodeResolve()]
-})
-build({
-  entry: 'index.js',
-  output: 'docsify.min.js',
-  plugins: [commonjs(), nodeResolve(), uglify()]
-})
+  if (isProd) {
+    build({
+      input: 'src/core/index.js',
+      output: 'docsify.min.js',
+      plugins: [uglify()]
+    })
+  }
+}
+const buildAllPlugin = function () {
+  var plugins = [
+    {name: 'search', input: 'search/index.js'},
+    {name: 'ga', input: 'ga.js'},
+    {name: 'matomo', input: 'matomo.js'},
+    {name: 'emoji', input: 'emoji.js'},
+    {name: 'external-script', input: 'external-script.js'},
+    {name: 'front-matter', input: 'front-matter/index.js'},
+    {name: 'zoom-image', input: 'zoom-image.js'},
+    {name: 'disqus', input: 'disqus.js'},
+    {name: 'gitalk', input: 'gitalk.js'}
+  ]
+
+  plugins.forEach(item => {
+    build({
+      input: 'src/plugins/' + item.input,
+      output: 'plugins/' + item.name + '.js'
+    })
+  })
+
+  if (isProd) {
+    plugins.forEach(item => {
+      build({
+        input: 'src/plugins/' + item.input,
+        output: 'plugins/' + item.name + '.min.js',
+        plugins: [uglify()]
+      })
+    })
+  }
+}
+
+if (!isProd) {
+  chokidar
+    .watch(['src/core', 'src/plugins'], {
+      atomic: true,
+      awaitWriteFinish: {
+        stabilityThreshold: 1000,
+        pollInterval: 100
+      }
+    })
+    .on('change', p => {
+      console.log('[watch] ', p)
+      const dirs = p.split(path.sep)
+      if (dirs[1] === 'core') {
+        buildCore()
+      } else if (dirs[2]) {
+        const name = path.basename(dirs[2], '.js')
+        const input = `src/plugins/${name}${
+          /\.js/.test(dirs[2]) ? '' : '/index'
+        }.js`
+
+        build({
+          input,
+          output: 'plugins/' + name + '.js'
+        })
+      }
+    })
+    .on('ready', () => {
+      console.log('[start]')
+      buildCore()
+      buildAllPlugin()
+    })
+} else {
+  buildCore()
+  buildAllPlugin()
+}

build/cover.js

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

build/css.js

@@ -0,0 +1,41 @@
+const fs = require('fs')
+const path = require('path')
+const {spawn} = require('child_process')
+
+const args = process.argv.slice(2)
+fs.readdir(path.join(__dirname, '../src/themes'), (err, files) => {
+    if (err) {
+        console.log('err', err)
+        return
+    }
+    files.map(async (file) => {
+        if (/\.styl/g.test(file)) {
+            var stylusCMD;
+            const stylusBin = ['node_modules', 'stylus', 'bin', 'stylus'].join(path.sep)
+            var cmdargs = [
+                stylusBin,
+                `src/themes/${file}`,
+                '-u',
+                'autoprefixer-stylus'
+            ]
+            cmdargs = cmdargs.concat(args)
+
+            stylusCMD = spawn('node', cmdargs, { shell: true })
+
+            stylusCMD.stdout.on('data', (data) => {
+                console.log(`[Stylus Build ] stdout: ${data}`);
+            });
+
+            stylusCMD.stderr.on('data', (data) => {
+                console.error(`[Stylus Build ] stderr: ${data}`);
+            });
+
+            stylusCMD.on('close', (code) => {
+                console.log(`[Stylus Build ] child process exited with code ${code}`);
+            });
+        } else {
+            return
+        }
+
+    })
+})

build/mincss.js

@@ -0,0 +1,12 @@
+const cssnano = require('cssnano').process
+const path = require('path')
+const fs = require('fs')
+
+files = fs.readdirSync(path.resolve('lib/themes'))
+
+files.forEach(file => {
+  file = path.resolve('lib/themes', file)
+  cssnano(fs.readFileSync(file)).then(result => {
+    fs.writeFileSync(file, result.css)
+  })
+})

build/release.sh

@@ -0,0 +1,52 @@
+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 ..."
+
+  # Removing test script as non - availibity of tests. Will Add it once tests are completed 
+
+  # npm run test
+
+  # build
+  VERSION=$VERSION npm run build
+
+  # update packages
+  cd packages/docsify-server-renderer
+  npm version $VERSION
+  if [[ -z $RELEASE_TAG ]]; then
+    npm publish
+  else
+    npm publish --tag $RELEASE_TAG
+  fi
+  cd -
+
+  # commit
+  git add -A
+  git commit -m "[build] $VERSION $RELEASE_TAG"
+  npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
+
+  # changelog
+  node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s
+
+  git add .
+  git commit -m "chore: add changelog $VERSION"
+
+  # publish
+  git tag v$VERSION
+  git push origin refs/tags/v$VERSION
+  git push
+  if [[ -z $RELEASE_TAG ]]; then
+    npm publish
+  else
+    npm publish --tag $RELEASE_TAG
+  fi
+fi

build/ssr.js

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

cypress.json

@@ -0,0 +1,3 @@
+{
+  "video": false
+}

cypress/fixtures/tpl/docs.index.html

@@ -0,0 +1,123 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>docsify-e2e-tests</title>
+    <link rel="icon" href="_media/favicon.ico" />
+    <meta
+      name="google-site-verification"
+      content="6t0LoIeFksrjF4c9sqUEsVXiQNxLp2hgoqo0KryT-sE"
+    />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta
+      name="keywords"
+      content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages"
+    />
+    <meta name="description" content="A magical documentation generator." />
+    <meta
+      name="viewport"
+      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
+    />
+    <link rel="stylesheet" href="lib/themes/vue.css" title="vue" />
+    <link rel="stylesheet" href="lib/themes/dark.css" title="dark" disabled />
+    <link rel="stylesheet" href="lib/themes/buble.css" title="buble" disabled />
+    <link rel="stylesheet" href="lib/themes/pure.css" title="pure" disabled />
+    <script src="//unpkg.com/docsify-plugin-codefund/index.js"></script>
+    <style>
+      nav.app-nav li ul {
+        min-width: 100px;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="app">Loading Docsify e2e tests suite...</div>
+    <script>
+      window.$docsify = {
+        alias: {
+          '.*?/awesome':
+            'https://raw.githubusercontent.com/docsifyjs/awesome-docsify/master/README.md',
+          '.*?/changelog':
+            'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG.md',
+          '/.*/_navbar.md': '/_navbar.md',
+          '/zh-cn/(.*)':
+            'https://raw.githubusercontent.com/docsifyjs/docs-zh/master/$1',
+          '/de-de/(.*)':
+            'https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1',
+          '/ru/(.*)':
+            'https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1',
+          '/es/(.*)':
+            'https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1'
+        },
+        auto2top: true,
+        coverpage: true,
+        executeScript: true,
+        loadSidebar: true,
+        loadNavbar: true,
+        mergeNavbar: true,
+        maxLevel: 4,
+        subMaxLevel: 2,
+        ga: 'UA-106147152-1',
+        matomo: {
+          host: '//matomo.thunderwave.de',
+          id: 6
+        },
+        name: 'docsify',
+        search: {
+          noData: {
+            '/de-de/': 'Keine Ergebnisse!',
+            '/zh-cn/': '没有结果!',
+            '/': 'No results!'
+          },
+          paths: 'auto',
+          placeholder: {
+            '/de-de/': 'Suche',
+            '/zh-cn/': '搜索',
+            '/': 'Search'
+          }
+        },
+        formatUpdated: '{MM}/{DD} {HH}:{mm}',
+        plugins: [
+          function(hook, vm) {
+            hook.beforeEach(function(html) {
+              if (/githubusercontent\.com/.test(vm.route.file)) {
+                url = vm.route.file
+                  .replace('raw.githubusercontent.com', 'github.com')
+                  .replace(/\/master/, '/blob/master')
+              } else {
+                url =
+                  'https://github.com/docsifyjs/docsify/blob/master/docs/' +
+                  vm.route.file
+              }
+              var editHtml = '[:memo: Edit Document](' + url + ')\n'
+              return (
+                editHtml +
+                html +
+                '\n\n----\n\n' +
+                '<a href="https://docsify.js.org" target="_blank" style="color: inherit; font-weight: normal; text-decoration: none;">Powered by docsify</a>'
+              )
+            })
+          }
+        ]
+      }
+    </script>
+    <script src="lib/docsify.min.js"></script>
+    <script src="lib/plugins/search.min.js"></script>
+    <script src="lib/plugins/ga.min.js"></script>
+    <script src="lib/plugins/matomo.min.js"></script>
+    <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+    <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+    <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+
+    <script>
+      ;((window.gitter = {}).chat = {}).options = {
+        room: 'docsifyjs/Lobby'
+      }
+    </script>
+    <script
+      src="https://sidecar.gitter.im/dist/sidecar.v1.js"
+      async
+      defer
+    ></script>
+  </body>
+</html>

cypress/integration/sidebar/config.spec.js

@@ -0,0 +1,344 @@
+context('sidebar.configurations', () => {
+  beforeEach(() => {
+    cy.visit('http://localhost:3000')
+  })
+
+  const quickStartIds = [
+    'initialize',
+    'writing-content',
+    'preview-your-site',
+    'manual-initialization',
+    'loading-dialog'
+  ]
+  quickStartIds.forEach(id => {
+    it('go to #quickstart?id=' + id, () => {
+      cy.get(
+        '.sidebar-nav > :nth-child(1) > :nth-child(1) > ul > :nth-child(1) > a'
+      ).click()
+
+      cy.get(`a.section-link[href='#/quickstart?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const configurationIds = [
+    'el',
+    'repo',
+    'maxlevel',
+    'loadnavbar',
+    'loadsidebar',
+    'submaxlevel',
+    'auto2top',
+    'homepage',
+    'basepath',
+    'relativepath',
+    'coverpage',
+    'logo',
+    'name',
+    'namelink',
+    'markdown',
+    'themecolor',
+    'alias',
+    'autoheader',
+    'executescript',
+    'noemoji',
+    'mergenavbar',
+    'formatupdated',
+    'externallinktarget',
+    'cornerexternallinktarget',
+    'externallinkrel',
+    'routermode',
+    'nocompilelinks',
+    'onlycover',
+    'requestheaders',
+    'ext',
+    'fallbacklanguages',
+    'notfoundpage'
+  ]
+  configurationIds.forEach(id => {
+    it('go to #configuration?id=' + id, () => {
+      cy.get('[href="#/configuration"]').click()
+
+      cy.get(`a.section-link[href='#/configuration?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500) // its more far from the cover
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const morePagesIds = [
+    'sidebar',
+    'nested-sidebars',
+    'set-page-titles-from-sidebar-selection',
+    'table-of-contents',
+    'ignoring-subheaders'
+  ]
+  morePagesIds.forEach(id => {
+    it('go to #more-pages?id=' + id, () => {
+      cy.get('[href="#/more-pages"]').click()
+
+      cy.get(`a.section-link[href='#/more-pages?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const customNavbarIds = [
+    'html',
+    'markdown',
+    'nesting',
+    'combining-custom-navbars-with-the-emoji-plugin'
+  ]
+  customNavbarIds.forEach(id => {
+    it('go to #custom-navbar?id=' + id, () => {
+      cy.get('[href="#/custom-navbar"]').click()
+
+      cy.get(`a.section-link[href='#/custom-navbar?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const coverIds = [
+    'basic-usage',
+    'custom-background',
+    'coverpage-as-homepage',
+    'multiple-covers'
+  ]
+  coverIds.forEach(id => {
+    it('go to #cover?id=' + id, () => {
+      cy.get('[href="#/cover"]').click()
+
+      cy.get(`a.section-link[href='#/cover?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const themesIds = ['other-themes']
+  themesIds.forEach(id => {
+    it('go to #themes?id=' + id, () => {
+      cy.get('[href="#/themes"]').click()
+
+      cy.get(`a.section-link[href='#/themes?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const pluginsIds = [
+    'full-text-search',
+    'google-analytics',
+    'emoji',
+    'external-script',
+    'zoom-image',
+    'edit-on-github',
+    'demo-code-with-instant-preview-and-jsfiddle-integration',
+    'copy-to-clipboard',
+    'disqus',
+    'gitalk',
+    'pagination',
+    'codefund',
+    'tabs',
+    'more-plugins'
+  ]
+  pluginsIds.forEach(id => {
+    it('go to #plugins?id=' + id, () => {
+      cy.get('[href="#/plugins"]').click()
+
+      cy.get(`a.section-link[href='#/plugins?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const writeAPluginIds = ['full-configuration', 'example', 'tips']
+  writeAPluginIds.forEach(id => {
+    it('go to #write-a-plugin?id=' + id, () => {
+      cy.get('[href="#/write-a-plugin"]').click()
+
+      cy.get(`a.section-link[href='#/write-a-plugin?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const markdownIds = ['supports-mermaid']
+  markdownIds.forEach(id => {
+    it('go to #markdown?id=' + id, () => {
+      cy.get('[href="#/markdown"]').click()
+
+      cy.get(`a.section-link[href='#/markdown?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  it('go to #Language-highlight', () => {
+    cy.get('a[href="#/language-highlight"]')
+      .click()
+      .then(() => {
+        cy.wait(500)
+        cy.matchImageSnapshot()
+      })
+  })
+
+  // const deployIds = [
+  //   'github-pages',
+  //   'gitlab-pages',
+  //   'firebase-hosting',
+  //   'vps',
+  //   'netlify',
+  //   'zeit-now',
+  //   'aws-amplify'
+  // ]
+  // deployIds.forEach(id => {
+  //   it('go to #deploy?id=' + id, () => {
+  //     cy.get('[href="#/deploy"]').click()
+
+  //     cy.get(`a.section-link[href='#/deploy?id=${id}']`)
+  //       .click()
+  //       .then(() => {
+  //         cy.wait(500)
+  //         cy.matchImageSnapshot()
+  //       })
+  //   })
+  // })
+
+  const helpersIds = [
+    'important-content',
+    'general-tips',
+    'ignore-to-compile-link',
+    'set-target-attribute-for-link',
+    'disable-link',
+    'github-task-lists',
+    'image-resizing',
+    'customise-id-for-headings',
+    'markdown-in-html-tag'
+  ]
+  helpersIds.forEach(id => {
+    it('go to #helpers?id=' + id, () => {
+      cy.get('[href="#/helpers"]').click()
+
+      cy.get(`a.section-link[href='#/helpers?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const vueIds = ['basic-usage', 'combine-vuep-to-write-playground']
+  vueIds.forEach(id => {
+    it('go to #vue?id=' + id, () => {
+      cy.get('[href="#/vue"]').click()
+
+      cy.get(`a.section-link[href='#/vue?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const cdnIds = [
+    'latest-version',
+    'specific-version',
+    'compressed-file',
+    'other-cdn'
+  ]
+  cdnIds.forEach(id => {
+    it('go to #cdn?id=' + id, () => {
+      cy.get('[href="#/cdn"]').click()
+
+      cy.get(`a.section-link[href='#/cdn?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const pwaIds = ['create-serviceworker', 'register', 'enjoy-it']
+  pwaIds.forEach(id => {
+    it('go to #pwa?id=' + id, () => {
+      cy.get('[href="#/pwa"]').click()
+
+      cy.get(`a.section-link[href='#/pwa?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+
+  const ssrIds = [
+    'why-ssr',
+    'quick-start',
+    'custom-template',
+    'configuration',
+    'deploy-for-your-vps'
+  ]
+
+  ssrIds.forEach(id => {
+    it('go to #ssr?id=' + id, () => {
+      cy.get('[href="#/ssr"]').click()
+
+      cy.get(`a.section-link[href='#/ssr?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+  const embedFilesIds = [
+    'embedded-file-type',
+    'embedded-code-fragments',
+    'tag-attribute',
+    'the-code-block-highlight'
+  ]
+  embedFilesIds.forEach(id => {
+    it('go to #embed-files?id=' + id, () => {
+      cy.get('[href="#/embed-files"]').click()
+
+      cy.get(`a.section-link[href='#/embed-files?id=${id}']`)
+        .click()
+        .then(() => {
+          cy.wait(500)
+          cy.matchImageSnapshot()
+        })
+    })
+  })
+})

cypress/live.server.js

@@ -0,0 +1,13 @@
+const path = require('path')
+const LiveServer = require('live-server')
+
+const fixturePath = path.join(__dirname, './fixtures/docs')
+const args = process.argv.slice(2)
+console.log('[e2e tests] : args passed to live server', args)
+const params = {
+  port: args[0] || 3000,
+  root: args[1] || fixturePath,
+  open: false
+  // NoBrowser: true
+}
+LiveServer.start(params)

cypress/plugins/index.js

@@ -0,0 +1,18 @@
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+const { addMatchImageSnapshotPlugin } = require('cypress-image-snapshot/plugin')
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+  addMatchImageSnapshotPlugin(on, config)
+}

cypress/setup.js

@@ -0,0 +1,75 @@
+const copyDir = require('copy-dir')
+const path = require('path')
+const fs = require('fs')
+const { spawn } = require('child_process')
+
+const setup = async () => {
+  const PORT = process.env.PORT || 3000
+  global.__LIVESERVER__ = null
+  global.PORT = PORT
+
+  /**
+   * IN this test suite, we are going to test our docs site with all the css,js linked to our local build packages
+   *
+   *  1.1 Copy ../docs --> ./fixtures/docs
+   *  1.2 copy lib,themes --> ./fixtures/
+   *  2. change the content of fixtures/docs/index.html to use all the links from our local build
+   *  3. now jest runner will run to test all the *.spec.js files
+   *
+   */
+
+  const shippedDirs = ['lib', 'themes']
+
+  // 1
+  const docsPath = path.join(process.cwd(), './docs')
+  const fixtureDocsPath = path.join(__dirname, './fixtures/docs')
+
+  // 1.1
+  console.log('[cypress test docs] Copying the docs --> cypress/fixtures/docs')
+  copyDir.sync(docsPath, fixtureDocsPath)
+
+  // 1.2
+  shippedDirs.forEach(dir => {
+    const fromPath = path.join(process.cwd(), dir)
+    const toPath = path.join(__dirname, `./fixtures/docs/${dir}`)
+    console.log(
+      `[cypress test docs] Copying  ${dir} --> cypress/fixtures/docs/${dir}`
+    )
+    copyDir.sync(fromPath, toPath)
+  })
+
+  // 2
+  console.log(
+    '[cypress test docs] Replacing content the tpl/index.html --> cypress/fixtures/docs/index.html'
+  )
+  const indexHTMLtplPath = path.join(
+    __dirname,
+    './fixtures/tpl/docs.index.html'
+  )
+  const fixtureIndexPath = path.join(__dirname, './fixtures/docs/index.html')
+  const data = fs.readFileSync(indexHTMLtplPath, 'utf8')
+
+  // 3
+  const fixturePath = path.join(__dirname, './fixtures/docs')
+
+  fs.writeFileSync(fixtureIndexPath, data, 'utf8')
+  const child = spawn('node', [
+    path.join(__dirname, './live.server.js'),
+    PORT,
+    fixturePath
+  ])
+  child.on('exit', code => {
+    console.log(`Child process exited with code ${code}`)
+  })
+  child.stdout.on('data', data => {
+    console.log(`stdout: ${data}`)
+  })
+  child.stderr.on('data', data => {
+    console.log(`stderr: ${data}`)
+  })
+
+  // LiveServer.start(params)
+  global.__LIVESERVER__ = child
+}
+
+setup()