chore: add changelog 4.9.2

Fix #812

.github/ISSUE_TEMPLATE.md

@@ -1,2 +0,0 @@
-<!-- Love docsify? Please consider supporting our collective:
-👉  https://opencollective.com/docsify/donate -->

.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

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

CHANGELOG.md

@@ -1,3 +1,66 @@
+<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
+
+* allows relative path, fixed [#590](https://github.com/docsifyjs/docsify/issues/590) ([31654f1](https://github.com/docsifyjs/docsify/commit/31654f1))
+
+
+
+<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
+
+* **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))
+
+
+
+<a name="4.8.6"></a>
+## [4.8.6](https://github.com/docsifyjs/docsify/compare/v4.8.5...v4.8.6) (2018-11-12)
+
+
+### Bug Fixes
+
+* IE10 compatibility ([#691](https://github.com/docsifyjs/docsify/issues/691)) ([4db8cd6](https://github.com/docsifyjs/docsify/commit/4db8cd6))
+
+
+
+<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)
 

README.md

@@ -27,6 +27,7 @@
 
 ## Links
 
+- [`develop` branch preview](https://docsifyjs.netlify.com/)
 - [Documentation](https://docsify.js.org)
 - [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)
@@ -40,7 +41,7 @@
 - Smart full-text search plugin
 - Multiple themes
 - Useful plugin API
-- Compatible with IE10+
+- Compatible with IE11
 - Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
 - Support embedded files
 

docs/README.md

@@ -16,7 +16,7 @@ See the [Quick start](quickstart.md) guide for more details.
 - Multiple themes
 - Useful plugin API
 - Emoji support
-- Compatible with IE10+
+- Compatible with IE11
 - Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
 
 ## Examples

docs/_coverpage.md

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

docs/_media/example.js

@@ -0,0 +1,16 @@
+import fetch from 'fetch'
+
+const URL = 'https://example.com'
+const PORT = 8080
+
+/// [demo]
+const result = fetch(`${URL}:${PORT}`)
+  .then(function(response) {
+    return response.json();
+  })
+  .then(function(myJson) {
+    console.log(JSON.stringify(myJson));
+  });
+/// [demo]
+
+result.then(console.log).catch(console.error)

docs/configuration.md

@@ -150,6 +150,46 @@ window.$docsify = {
 };
 ```
 
+## relativePath
+
+- Type: `Boolean`
+- Default: `false`
+
+If **true** links are relative to the current context.
+
+For example, the directory structure is as follows:
+
+```text
+.
+└── docs
+    ├── README.md
+    ├── guide.md
+    └── zh-cn
+        ├── README.md
+        ├── guide.md
+        └── config
+            └── example.md
+```
+
+With relative path **enabled** and current URL `http://domain.com/zh-cn/README`, given links will resolve to:
+
+```text
+guide.md              => http://domain.com/zh-cn/guide
+config/example.md     => http://domain.com/zh-cn/config/example
+../README.md          => http://domain.com/README
+/README.md            => http://domain.com/README
+```
+
+```js
+window.$docsify = {
+  // Relative path enabled
+  relativePath: true,
+
+  // Relative path disabled (default value)
+  relativePath: false
+};
+```
+
 ## coverpage
 
 - Type: `Boolean|String|String[]|Object`

docs/deploy.md

@@ -87,3 +87,45 @@ When using the HTML5 router, you need to set up redirect rules that redirect all
 ```sh
 /*    /index.html   200
 ```
+
+## AWS Amplify
+
+1. Set the routerMode in the Docsify project `index.html` to *history* mode.
+
+```html
+<script>
+    window.$docsify = {
+      loadSidebar: true,
+      routerMode: 'history'
+    }
+</script>
+```
+
+2. Login to your [AWS Console](https://aws.amazon.com).
+3. Go to the [AWS Amplify Dashboard](https://aws.amazon.com/amplify).
+4. Choose the **Deploy** route to setup your project.
+5. When prompted, keep the build settings empty if you're serving your docs within the root directory. If you're serving your docs from a different directory, customise your amplify.yml
+
+```yml
+version: 0.1
+frontend:
+  phases:
+    build:
+      commands: 
+        - echo "Nothing to build"
+  artifacts:
+    baseDirectory: /docs
+    files:
+      - '**/*'
+  cache:
+    paths: []
+
+```
+
+6. Add the following Redirect rules in their displayed order.
+
+| Source address | Target address | Type          |
+|----------------|----------------|---------------|
+| /<*>.md        | /<*>.md        | 200 (Rewrite) |
+| /<*>           | /index.html    | 200 (Rewrite) |        
+

docs/embed-files.md

@@ -39,6 +39,21 @@ You will get it
 
 [filename](_media/example.md ':include :type=code')
 
+## Embedded code fragments
+Sometimes you don't want to embed a whole file. Maybe because you need just a few lines but you want to compile and test the file in CI.
+
+```markdown
+[filename](_media/example.js ':include :type=code :fragment=demo')
+```
+
+In your code file you need to surround the fragment between `/// [demo]` lines (before and after the fragment).  
+Alternatively you can use `### [demo]`.
+
+Example:
+
+[filename](_media/example.js ':include :type=code :fragment=demo')
+
+
 ## Tag attribute
 
 If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.

docs/helpers.md

@@ -88,6 +88,7 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 ![logo](https://docsify.js.org/_media/icon.svg ':size=100')
 
 <!-- Support percentage -->
+
 ![logo](https://docsify.js.org/_media/icon.svg ':size=10%')
 ```
 
@@ -99,4 +100,46 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 
 ```md
 ### 你好，世界！ :id=hello-world
-```
+```
+
+## Markdown in html tag
+
+You need to insert a space between the html and markdown content.
+This is useful for rendering markdown content in the details element.
+
+```markdown
+<details>
+<summary>Self-assessment (Click to expand)</summary>
+
+- Abc
+- Abc
+
+</details>
+```
+
+<details>
+<summary>Self-assessment (Click to expand)</summary>
+
+- Abc
+- Abc
+
+</details>
+
+Or markdown content can be wrapped in html tag.
+
+```markdown
+<div style='color: red'>
+
+- listitem
+- listitem
+- listitem
+
+</div>
+```
+
+<div style='color: red'>
+
+- Abc
+- Abc
+
+</div>

docs/index.html

@@ -44,6 +44,10 @@
       maxLevel: 4,
       subMaxLevel: 2,
       ga: 'UA-106147152-1',
+      matomo: {
+        host: '//matomo.thunderwave.de',
+        id: 6
+      },
       name: 'docsify',
       search: {
         noData: {
@@ -84,6 +88,7 @@
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
+  <script src="//unpkg.com/docsify/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>

docs/markdown.md

@@ -36,6 +36,7 @@ window.$docsify = {
 //  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
 //  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
 
+var num = 0;
 mermaid.initialize({ startOnLoad: false });
 
 window.$docsify = {
@@ -44,7 +45,7 @@ window.$docsify = {
       code: function(code, lang) {
         if (lang === "mermaid") {
           return (
-            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+            '<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + "</div>"
           );
         }
         return this.origin.code.apply(this, arguments);

docs/more-pages.md

@@ -72,6 +72,16 @@ You can specify `alias` to avoid unnecessary fallback.
 
 !> You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
 
+## Set Page Titles from Sidebar Selection
+
+A page's `title` tag is generated from the _selected_ sidebar item name. For better SEO, you can customize the title by specifying a string after the filename.
+
+```markdown
+<!-- docs/_sidebar.md -->
+* [Home](/)
+* [Guide](guide.md "The greatest guide in the world")
+```
+
 ## Table of Contents
 
 Once you've created `_sidebar.md`, the sidebar content is automatically generated based on the headers in the markdown files.

docs/plugins.md

@@ -40,6 +40,10 @@ By default, the hyperlink on the current page is recognized and the content is s
       depth: 2,
 
       hideOtherSidebarContent: false, // whether or not to hide other sidebar content
+
+      // To avoid search index collision
+      // between multiple websites under the same domain
+      namespace: 'website-1',
     }
   }
 </script>

docs/ssr.md

@@ -111,7 +111,7 @@ var readFileSync = require('fs').readFileSync
 
 // init
 var renderer = new Renderer({
-  template: readFileSync('./docs/index.template.html', 'utf-8').,
+  template: readFileSync('./docs/index.template.html', 'utf-8'),
   config: {
     name: 'docsify',
     repo: 'docsifyjs/docsify'

docs/write-a-plugin.md

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

index.html

@@ -21,48 +21,64 @@
   <script>
     window.$docsify = {
       alias: {
-        '.*?/changelog': 'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
+        '.*?/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'
       },
-      notFoundPage: '_404.html',
       auto2top: true,
       basePath: '/docs/',
-      executeScript: true,
-      loadNavbar: true,
-      loadSidebar: true,
       coverpage: true,
-      name: 'docsify',
-      subMaxLevel: 2,
+      executeScript: true,
+      loadSidebar: true,
+      loadNavbar: true,
       mergeNavbar: true,
+      maxLevel: 4,
+      subMaxLevel: 2,
+      name: 'docsify',
+      search: {
+        noData: {
+          '/de-de/': 'Keine Ergebnisse!',
+          '/zh-cn/': '没有结果!',
+          '/': 'No results!'
+        },
+        paths: 'auto',
+        placeholder: {
+          '/de-de/': 'Suche',
+          '/zh-cn/': '搜索',
+          '/': 'Search'
+        }
+      },
       formatUpdated: '{MM}/{DD} {HH}:{mm}',
       plugins: [
         function (hook, vm) {
           hook.beforeEach(function (html) {
-            var url
             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/' + vm.route.file
+              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'
-              + 'Last modified {docsify-updated} '
-              + editHtml
+              + '<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.js"></script>
+  <script src="/lib/plugins/search.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
 </body>
 
 </html>

lib/docsify.js

@@ -85,7 +85,8 @@ function config () {
       formatUpdated: '',
       externalLinkTarget: '_blank',
       routerMode: 'hash',
-      noCompileLinks: []
+      noCompileLinks: [],
+      relativePath: false
     },
     window.$docsify
   );
@@ -3157,7 +3158,7 @@ slugify.clear = function () {
 };
 
 function replace(m, $1) {
-  return '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' + $1 + '.png" alt="' + $1 + '" />'
+  return '<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/' + $1 + '.png" alt="' + $1 + '" />'
 }
 
 function emojify(text) {
@@ -3222,6 +3223,20 @@ var cleanPath = cached(function (path) {
   return path.replace(/^\/+/, '/').replace(/([^:])\/{2,}/g, '$1/')
 });
 
+var resolvePath = cached(function (path) {
+  var segments = path.replace(/^\//, '').split('/');
+  var resolved = [];
+  for (var i = 0, len = segments.length; i < len; i++) {
+    var segment = segments[i];
+    if (segment === '..') {
+      resolved.pop();
+    } else if (segment !== '.') {
+      resolved.push(segment);
+    }
+  }
+  return '/' + resolved.join('/')
+});
+
 function getPath() {
   var args = [], len = arguments.length;
   while ( len-- ) args[ len ] = arguments[ len ];
@@ -3335,7 +3350,7 @@ function getAndRemoveConfig(str) {
     str = str
       .replace(/^'/, '')
       .replace(/'$/, '')
-      .replace(/:([\w-]+)=?([\w-]+)?/g, function (m, key, value) {
+      .replace(/(?:^|\s):([\w-]+)=?([\w-]+)?/g, function (m, key, value) {
         config[key] = (value && value.replace(/&quot;/g, '')) || true;
         return ''
       })
@@ -3483,6 +3498,7 @@ Compiler.prototype.compileEmbed = function compileEmbed (href, title) {
       embed = compileMedia[type].call(this, href, title);
       embed.type = type;
     }
+    embed.fragment = config.fragment;
 
     return embed
   }
@@ -3571,7 +3587,7 @@ Compiler.prototype._initRenderer = function _initRenderer () {
       }
       href = router.toURL(href, null, router.getCurrentPath());
     } else {
-      attrs += href.startsWith('mailto:') ? '' : (" target=\"" + linkTarget + "\"");
+      attrs += href.indexOf('mailto:') === 0 ? '' : (" target=\"" + linkTarget + "\"");
     }
 
     if (config.target) {
@@ -3633,6 +3649,23 @@ Compiler.prototype._initRenderer = function _initRenderer () {
 
     return ("<img src=\"" + url + "\"data-origin=\"" + href + "\" alt=\"" + text + "\"" + attrs + ">")
   };
+  origin.list = renderer.list = function (body, ordered, start) {
+    var isTaskList = /<li class="task-list-item">/.test(body.split('class="task-list"')[0]);
+    var isStartReq = start && start > 1;
+    var tag = ordered ? 'ol' : 'ul';
+    var tagAttrs = [
+      (isTaskList ? 'class="task-list"' : ''),
+      (isStartReq ? ("start=\"" + start + "\"") : '')
+    ].join(' ').trim();
+
+    return ("<" + tag + " " + tagAttrs + ">" + body + "</" + tag + ">")
+  };
+  origin.listitem = renderer.listitem = function (text) {
+    var isTaskItem = /^(<input.*type="checkbox"[^>]*>)/.test(text);
+    var html = isTaskItem ? ("<li class=\"task-list-item\"><label>" + text + "</label></li>") : ("<li>" + text + "</li>");
+
+    return html
+  };
 
   renderer.origin = origin;
 
@@ -3708,6 +3741,9 @@ function btn(el) {
   var toggle = function (_) { return body.classList.toggle('close'); };
 
   el = getNode(el);
+  if (el == null) {
+    return
+  }
   on(el, 'click', function (e) {
     e.stopPropagation();
     toggle();
@@ -3723,7 +3759,9 @@ function btn(el) {
 
 function collapse(el) {
   el = getNode(el);
-
+  if (el == null) {
+    return
+  }
   on(el, 'click', function (ref) {
     var target = ref.target;
 
@@ -3761,8 +3799,10 @@ function sticky() {
  */
 function getAndActive(router, el, isParent, autoTitle) {
   el = getNode(el);
-
-  var links = findAll(el, 'a');
+  var links = [];
+  if (el != null) {
+    links = findAll(el, 'a');
+  }
   var hash = decodeURI(router.toURL(router.getCurrentPath()));
   var target;
 
@@ -3965,7 +4005,10 @@ function scrollActiveSidebar(router) {
   coverHeight = cover ? cover.offsetHeight : 0;
 
   var sidebar = getNode('.sidebar');
-  var lis = findAll(sidebar, 'li');
+  var lis = [];
+  if (sidebar != null) {
+    lis = findAll(sidebar, 'li');
+  }
 
   for (var i = 0, len = lis.length; i < len; i += 1) {
     var li = lis[i];
@@ -4049,6 +4092,11 @@ function walkFetchEmbed(ref, cb) {
           if (token.embed.type === 'markdown') {
             embedToken = compile.lexer(text);
           } else if (token.embed.type === 'code') {
+            if (token.embed.fragment) {
+              var fragment = token.embed.fragment;
+              var pattern = new RegExp(("(?:###|\\/\\/\\/)\\s*\\[" + fragment + "\\]([\\s\\S]*)(?:###|\\/\\/\\/)\\s*\\[" + fragment + "\\]"));
+              text = ((text.match(pattern) || [])[1] || '').trim();
+            }
             embedToken = compile.lexer(
               '```' +
                 token.embed.lang +
@@ -4484,9 +4532,13 @@ History.prototype.toURL = function toURL (path, params, currentRoute) {
   if (local) {
     var idIndex = currentRoute.indexOf('?');
     path =
-      (idIndex > 0 ? currentRoute.substr(0, idIndex) : currentRoute) + path;
+      (idIndex > 0 ? currentRoute.substring(0, idIndex) : currentRoute) + path;
   }
 
+  if (this.config.relativePath && path.indexOf('/') !== 0) {
+    var currentDir = currentRoute.substring(0, currentRoute.lastIndexOf('/') + 1);
+    return cleanPath(resolvePath(currentDir + path))
+  }
   return cleanPath('/' + path)
 };
 
@@ -5003,12 +5055,19 @@ var util = Object.freeze({
 	isAbsolutePath: isAbsolutePath,
 	getParentPath: getParentPath,
 	cleanPath: cleanPath,
+	resolvePath: resolvePath,
 	getPath: getPath,
 	replaceSlug: replaceSlug
 });
 
 function initGlobalAPI () {
-  window.Docsify = {util: util, dom: dom, get: get, slugify: slugify};
+  window.Docsify = {
+    util: util,
+    dom: dom,
+    get: get,
+    slugify: slugify,
+    version: '4.9.2'
+  };
   window.DocsifyCompiler = Compiler;
   window.marked = marked;
   window.Prism = prism;
@@ -5044,11 +5103,6 @@ eventMixin(proto);
  */
 initGlobalAPI();
 
-/**
- * Version
- */
-Docsify.version = '4.8.4';
-
 /**
  * Run Docsify
  */

lib/plugins/emoji.js

@@ -893,7 +893,7 @@ var AllGithubEmoji = [
 window.emojify = function (match, $1) {
   return AllGithubEmoji.indexOf($1) === -1 ?
     match :
-    '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' +
+    '<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/' +
       $1 +
       '.png" alt="' +
       $1 +

lib/plugins/gitalk.js

@@ -8,10 +8,16 @@ function install(hook) {
     var main = dom.getNode('#main');
     div.style = "width: " + (main.clientWidth) + "px; margin: 0 auto 20px;";
     dom.appendTo(dom.find('.content'), div);
-    var script = dom.create('script');
-    var content = "gitalk.render('gitalk-container')";
-    script.textContent = content;
-    dom.appendTo(dom.body, script);
+  });
+
+  hook.doneEach(function (_) {
+    var el = document.getElementById('gitalk-container');
+    while (el.hasChildNodes()) {
+      el.removeChild(el.firstChild);
+    }
+
+    // eslint-disable-next-line
+    gitalk.render('gitalk-container');
   });
 }
 

lib/plugins/gitalk.min.js

@@ -1 +1 @@
-$docsify.plugins=[].concat(function(t){var a=Docsify.dom;t.mounted(function(t){var n=a.create("div");n.id="gitalk-container";var i=a.getNode("#main");n.style="width: "+i.clientWidth+"px; margin: 0 auto 20px;",a.appendTo(a.find(".content"),n);var e=a.create("script");e.textContent="gitalk.render('gitalk-container')",a.appendTo(a.body,e)})},$docsify.plugins);
+$docsify.plugins=[].concat(function(i){var e=Docsify.dom;i.mounted(function(i){var n=e.create("div");n.id="gitalk-container";var t=e.getNode("#main");n.style="width: "+t.clientWidth+"px; margin: 0 auto 20px;",e.appendTo(e.find(".content"),n)}),i.doneEach(function(i){for(var n=document.getElementById("gitalk-container");n.hasChildNodes();)n.removeChild(n.firstChild);gitalk.render("gitalk-container")})},$docsify.plugins);

lib/plugins/search.js

@@ -1,6 +1,18 @@
 (function () {
 var INDEXS = {};
 
+var LOCAL_STORAGE = {
+  EXPIRE_KEY: 'docsify.search.expires',
+  INDEX_KEY: 'docsify.search.index'
+};
+
+function resolveExpireKey(namespace) {
+  return namespace ? ((LOCAL_STORAGE.EXPIRE_KEY) + "/" + namespace) : LOCAL_STORAGE.EXPIRE_KEY
+}
+function resolveIndexKey(namespace) {
+  return namespace ? ((LOCAL_STORAGE.INDEX_KEY) + "/" + namespace) : LOCAL_STORAGE.INDEX_KEY
+}
+
 function escapeHtml(string) {
   var entityMap = {
     '&': '&',
@@ -17,7 +29,7 @@ function escapeHtml(string) {
 function getAllPaths(router) {
   var paths = [];
 
-  document.querySelectorAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(function (node) {
+  Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(function (node) {
     var href = node.href;
     var originHref = node.getAttribute('href');
     var path = router.parse(href).path;
@@ -34,9 +46,9 @@ function getAllPaths(router) {
   return paths
 }
 
-function saveData(maxAge) {
-  localStorage.setItem('docsify.search.expires', Date.now() + maxAge);
-  localStorage.setItem('docsify.search.index', JSON.stringify(INDEXS));
+function saveData(maxAge, expireKey, indexKey) {
+  localStorage.setItem(expireKey, Date.now() + maxAge);
+  localStorage.setItem(indexKey, JSON.stringify(INDEXS));
 }
 
 function genIndex(path, content, router, depth) {
@@ -154,9 +166,13 @@ function search(query) {
 
 function init$1(config, vm) {
   var isAuto = config.paths === 'auto';
-  var isExpired = localStorage.getItem('docsify.search.expires') < Date.now();
 
-  INDEXS = JSON.parse(localStorage.getItem('docsify.search.index'));
+  var expireKey = resolveExpireKey(config.namespace);
+  var indexKey = resolveIndexKey(config.namespace);
+
+  var isExpired = localStorage.getItem(expireKey) < Date.now();
+
+  INDEXS = JSON.parse(localStorage.getItem(indexKey));
 
   if (isExpired) {
     INDEXS = {};
@@ -177,7 +193,7 @@ function init$1(config, vm) {
       .get(vm.router.getFile(path), false, vm.config.requestHeaders)
       .then(function (result) {
         INDEXS[path] = genIndex(path, result, vm.router, config.depth);
-        len === ++count && saveData(config.maxAge);
+        len === ++count && saveData(config.maxAge, expireKey, indexKey);
       });
   });
 }
@@ -311,7 +327,8 @@ var CONFIG = {
   paths: 'auto',
   depth: 2,
   maxAge: 86400000, // 1 day
-  hideOtherSidebarContent: false
+  hideOtherSidebarContent: false,
+  namespace: undefined
 };
 
 var install = function (hook, vm) {
@@ -327,6 +344,7 @@ var install = function (hook, vm) {
     CONFIG.noData = opts.noData || CONFIG.noData;
     CONFIG.depth = opts.depth || CONFIG.depth;
     CONFIG.hideOtherSidebarContent = opts.hideOtherSidebarContent || CONFIG.hideOtherSidebarContent;
+    CONFIG.namespace = opts.namespace || CONFIG.namespace;
   }
 
   var isAuto = CONFIG.paths === 'auto';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.8.4",
+  "version": "4.9.2",
   "description": "A magical documentation generator.",
   "author": {
     "name": "qingwei-li",
@@ -27,16 +27,16 @@
     "dev": "run-p serve watch:*",
     "dev:ssr": "run-p serve:ssr watch:*",
     "lint": "eslint {src,packages} --fix",
-    "test": "run-p lint",
+    "test": "mocha test/*/**",
     "css": "stylus src/themes/*.styl -u autoprefixer-stylus",
     "watch:css": "run-p 'css -- -o themes -w'",
     "watch:js": "node build/build.js",
     "build:css:min": "mkdir lib/themes && run-p 'css -- -o lib/themes' && node build/mincss.js",
-    "build:css": "mkdir themes && run-p 'css --  -o themes'",
+    "build:css": "mkdir -p  themes && run-p 'css --  -o themes'",
     "build:js": "cross-env NODE_ENV=production node build/build.js",
     "build:ssr": "node build/ssr.js",
     "build:cover": "node build/cover.js",
-    "build": "rimraf lib themes && run-s build:js build:css build:css:min build:ssr build:cover",
+    "build": "rimraf lib themes/* && run-s build:js build:css build:css:min build:ssr build:cover",
     "pub:next": "cross-env RELEASE_TAG=next sh build/release.sh",
     "pub": "sh build/release.sh",
     "postinstall": "opencollective postinstall"
@@ -51,15 +51,19 @@
   },
   "devDependencies": {
     "autoprefixer-stylus": "^0.14.0",
+    "chai": "^4.2.0",
     "chokidar": "^2.0.2",
     "conventional-changelog-cli": "^1.3.5",
     "cross-env": "^5.1.3",
     "cssnano": "^3.10.0",
     "eslint": "^4.14.0",
     "eslint-config-xo-space": "^0.18.0",
+    "esm": "^3.1.4",
+    "jsdom": "^13.2.0",
     "lerna": "^2.5.1",
-    "live-server": "^1.2.0",
-    "npm-run-all": "^4.1.2",
+    "live-server": "^1.2.1",
+    "mocha": "^5.2.0",
+    "npm-run-all": "^4.1.5",
     "rimraf": "^2.6.2",
     "rollup": "^0.53.3",
     "rollup-plugin-async": "^1.2.0",

packages/docsify-server-renderer/package-lock.json

@@ -37,5 +37,5 @@
       "integrity": "sha1-6DWIAbhrg7F1YNTjw4LXrvIQCUQ="
     }
   },
-  "version": "4.8.4"
+  "version": "4.9.2"
 }

packages/docsify-server-renderer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify-server-renderer",
-  "version": "4.8.4",
+  "version": "4.9.2",
   "description": "docsify server renderer",
   "author": {
     "name": "qingwei-li",

src/core/config.js

@@ -25,7 +25,8 @@ export default function () {
       formatUpdated: '',
       externalLinkTarget: '_blank',
       routerMode: 'hash',
-      noCompileLinks: []
+      noCompileLinks: [],
+      relativePath: false
     },
     window.$docsify
   )

src/core/event/scroll.js

@@ -87,7 +87,10 @@ export function scrollActiveSidebar(router) {
   coverHeight = cover ? cover.offsetHeight : 0
 
   const sidebar = dom.getNode('.sidebar')
-  const lis = dom.findAll(sidebar, 'li')
+  let lis = []
+  if (sidebar != null) {
+    lis = dom.findAll(sidebar, 'li')
+  }
 
   for (let i = 0, len = lis.length; i < len; i += 1) {
     const li = lis[i]

src/core/event/sidebar.js

@@ -9,6 +9,9 @@ export function btn(el) {
   const toggle = _ => dom.body.classList.toggle('close')
 
   el = dom.getNode(el)
+  if (el == null) {
+    return
+  }
   dom.on(el, 'click', e => {
     e.stopPropagation()
     toggle()
@@ -24,7 +27,9 @@ export function btn(el) {
 
 export function collapse(el) {
   el = dom.getNode(el)
-
+  if (el == null) {
+    return
+  }
   dom.on(el, 'click', ({target}) => {
     if (
       target.nodeName === 'A' &&
@@ -60,8 +65,10 @@ export function sticky() {
  */
 export function getAndActive(router, el, isParent, autoTitle) {
   el = dom.getNode(el)
-
-  const links = dom.findAll(el, 'a')
+  let links = []
+  if (el != null) {
+    links = dom.findAll(el, 'a')
+  }
   const hash = decodeURI(router.toURL(router.getCurrentPath()))
   let target
 

src/core/global-api.js

@@ -7,7 +7,13 @@ import marked from 'marked'
 import prism from 'prismjs'
 
 export default function () {
-  window.Docsify = {util, dom, get, slugify}
+  window.Docsify = {
+    util,
+    dom,
+    get,
+    slugify,
+    version: '__VERSION__'
+  }
   window.DocsifyCompiler = Compiler
   window.marked = marked
   window.Prism = prism

src/core/index.js

@@ -35,11 +35,6 @@ eventMixin(proto)
  */
 initGlobalAPI()
 
-/**
- * Version
- */
-Docsify.version = '__VERSION__'
-
 /**
  * Run Docsify
  */

src/core/render/compiler.js

@@ -19,7 +19,7 @@ export function getAndRemoveConfig(str = '') {
     str = str
       .replace(/^'/, '')
       .replace(/'$/, '')
-      .replace(/:([\w-]+)=?([\w-]+)?/g, (m, key, value) => {
+      .replace(/(?:^|\s):([\w-]+)=?([\w-]+)?/g, (m, key, value) => {
         config[key] = (value && value.replace(/"/g, '')) || true
         return ''
       })
@@ -164,6 +164,7 @@ export class Compiler {
         embed = compileMedia[type].call(this, href, title)
         embed.type = type
       }
+      embed.fragment = config.fragment
 
       return embed
     }
@@ -241,7 +242,7 @@ export class Compiler {
         }
         href = router.toURL(href, null, router.getCurrentPath())
       } else {
-        attrs += href.startsWith('mailto:') ? '' : ` target="${linkTarget}"`
+        attrs += href.indexOf('mailto:') === 0 ? '' : ` target="${linkTarget}"`
       }
 
       if (config.target) {
@@ -301,6 +302,23 @@ export class Compiler {
 
       return `<img src="${url}"data-origin="${href}" alt="${text}"${attrs}>`
     }
+    origin.list = renderer.list = function (body, ordered, start) {
+      const isTaskList = /<li class="task-list-item">/.test(body.split('class="task-list"')[0])
+      const isStartReq = start && start > 1
+      const tag = ordered ? 'ol' : 'ul'
+      const tagAttrs = [
+        (isTaskList ? 'class="task-list"' : ''),
+        (isStartReq ? `start="${start}"` : '')
+      ].join(' ').trim()
+
+      return `<${tag} ${tagAttrs}>${body}</${tag}>`
+    }
+    origin.listitem = renderer.listitem = function (text) {
+      const isTaskItem = /^(<input.*type="checkbox"[^>]*>)/.test(text)
+      const html = isTaskItem ? `<li class="task-list-item"><label>${text}</label></li>` : `<li>${text}</li>`
+
+      return html
+    }
 
     renderer.origin = origin
 

src/core/render/embed.js

@@ -20,6 +20,11 @@ function walkFetchEmbed({embedTokens, compile, fetch}, cb) {
           if (token.embed.type === 'markdown') {
             embedToken = compile.lexer(text)
           } else if (token.embed.type === 'code') {
+            if (token.embed.fragment) {
+              const fragment = token.embed.fragment
+              const pattern = new RegExp(`(?:###|\\/\\/\\/)\\s*\\[${fragment}\\]([\\s\\S]*)(?:###|\\/\\/\\/)\\s*\\[${fragment}\\]`)
+              text = ((text.match(pattern) || [])[1] || '').trim()
+            }
             embedToken = compile.lexer(
               '```' +
                 token.embed.lang +

src/core/render/emojify.js

@@ -1,7 +1,7 @@
 import {inBrowser} from '../util/env'
 
 function replace(m, $1) {
-  return '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' + $1 + '.png" alt="' + $1 + '" />'
+  return '<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/' + $1 + '.png" alt="' + $1 + '" />'
 }
 
 export function emojify(text) {

src/core/router/history/base.js

@@ -3,7 +3,8 @@ import {
   isAbsolutePath,
   stringifyQuery,
   cleanPath,
-  replaceSlug
+  replaceSlug,
+  resolvePath
 } from '../util'
 import {noop, merge} from '../../util/core'
 
@@ -73,9 +74,13 @@ export class History {
     if (local) {
       const idIndex = currentRoute.indexOf('?')
       path =
-        (idIndex > 0 ? currentRoute.substr(0, idIndex) : currentRoute) + path
+        (idIndex > 0 ? currentRoute.substring(0, idIndex) : currentRoute) + path
     }
 
+    if (this.config.relativePath && path.indexOf('/') !== 0) {
+      const currentDir = currentRoute.substring(0, currentRoute.lastIndexOf('/') + 1)
+      return cleanPath(resolvePath(currentDir + path))
+    }
     return cleanPath('/' + path)
   }
 }

src/core/router/util.js

@@ -53,6 +53,20 @@ export const cleanPath = cached(path => {
   return path.replace(/^\/+/, '/').replace(/([^:])\/{2,}/g, '$1/')
 })
 
+export const resolvePath = cached(path => {
+  const segments = path.replace(/^\//, '').split('/')
+  let resolved = []
+  for (let i = 0, len = segments.length; i < len; i++) {
+    const segment = segments[i]
+    if (segment === '..') {
+      resolved.pop()
+    } else if (segment !== '.') {
+      resolved.push(segment)
+    }
+  }
+  return '/' + resolved.join('/')
+})
+
 export function getPath(...args) {
   return cleanPath(args.join('/'))
 }

src/plugins/emoji.js

@@ -892,7 +892,7 @@ const AllGithubEmoji = [
 window.emojify = function (match, $1) {
   return AllGithubEmoji.indexOf($1) === -1 ?
     match :
-    '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/' +
+    '<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/' +
       $1 +
       '.png" alt="' +
       $1 +

src/plugins/gitalk.js

@@ -7,10 +7,16 @@ function install(hook) {
     const main = dom.getNode('#main')
     div.style = `width: ${main.clientWidth}px; margin: 0 auto 20px;`
     dom.appendTo(dom.find('.content'), div)
-    const script = dom.create('script')
-    const content = `gitalk.render('gitalk-container')`
-    script.textContent = content
-    dom.appendTo(dom.body, script)
+  })
+
+  hook.doneEach(_ => {
+    const el = document.getElementById('gitalk-container')
+    while (el.hasChildNodes()) {
+      el.removeChild(el.firstChild)
+    }
+
+    // eslint-disable-next-line
+    gitalk.render('gitalk-container')
   })
 }
 

src/plugins/matomo.js

@@ -0,0 +1,37 @@
+function appendScript(options) {
+  const script = document.createElement('script')
+  script.async = true
+  script.src = options.host + '/matomo.js'
+  document.body.appendChild(script)
+}
+
+function init(options) {
+  window._paq = window._paq || []
+  window._paq.push(['trackPageView'])
+  window._paq.push(['enableLinkTracking'])
+  setTimeout(function() {
+    appendScript(options)
+    window._paq.push(['setTrackerUrl', options.host + '/matomo.php'])
+    window._paq.push(['setSiteId', options.id + ''])
+  }, 0)
+}
+
+function collect() {
+  if (!window._paq) {
+    init($docsify.matomo)
+  }
+  window._paq.push(['setCustomUrl',  window.location.hash.substr(1)])
+  window._paq.push(['setDocumentTitle', document.title])
+  window._paq.push(['trackPageView'])
+}
+
+const install = function (hook) {
+  if (!$docsify.matomo) {
+    console.error('[Docsify] matomo is required.')
+    return
+  }
+
+  hook.beforeEach(collect)
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)

src/plugins/search/index.js

@@ -7,7 +7,8 @@ const CONFIG = {
   paths: 'auto',
   depth: 2,
   maxAge: 86400000, // 1 day
-  hideOtherSidebarContent: false
+  hideOtherSidebarContent: false,
+  namespace: undefined
 }
 
 const install = function (hook, vm) {
@@ -23,6 +24,7 @@ const install = function (hook, vm) {
     CONFIG.noData = opts.noData || CONFIG.noData
     CONFIG.depth = opts.depth || CONFIG.depth
     CONFIG.hideOtherSidebarContent = opts.hideOtherSidebarContent || CONFIG.hideOtherSidebarContent
+    CONFIG.namespace = opts.namespace || CONFIG.namespace
   }
 
   const isAuto = CONFIG.paths === 'auto'

src/plugins/search/search.js

@@ -1,5 +1,17 @@
 let INDEXS = {}
 
+const LOCAL_STORAGE = {
+  EXPIRE_KEY: 'docsify.search.expires',
+  INDEX_KEY: 'docsify.search.index'
+}
+
+function resolveExpireKey(namespace) {
+  return namespace ? `${LOCAL_STORAGE.EXPIRE_KEY}/${namespace}` : LOCAL_STORAGE.EXPIRE_KEY
+}
+function resolveIndexKey(namespace) {
+  return namespace ? `${LOCAL_STORAGE.INDEX_KEY}/${namespace}` : LOCAL_STORAGE.INDEX_KEY
+}
+
 function escapeHtml(string) {
   const entityMap = {
     '&': '&',
@@ -16,7 +28,7 @@ function escapeHtml(string) {
 function getAllPaths(router) {
   const paths = []
 
-  document.querySelectorAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(node => {
+  Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(node => {
     const href = node.href
     const originHref = node.getAttribute('href')
     const path = router.parse(href).path
@@ -33,9 +45,9 @@ function getAllPaths(router) {
   return paths
 }
 
-function saveData(maxAge) {
-  localStorage.setItem('docsify.search.expires', Date.now() + maxAge)
-  localStorage.setItem('docsify.search.index', JSON.stringify(INDEXS))
+function saveData(maxAge, expireKey, indexKey) {
+  localStorage.setItem(expireKey, Date.now() + maxAge)
+  localStorage.setItem(indexKey, JSON.stringify(INDEXS))
 }
 
 export function genIndex(path, content = '', router, depth) {
@@ -149,9 +161,13 @@ export function search(query) {
 
 export function init(config, vm) {
   const isAuto = config.paths === 'auto'
-  const isExpired = localStorage.getItem('docsify.search.expires') < Date.now()
 
-  INDEXS = JSON.parse(localStorage.getItem('docsify.search.index'))
+  const expireKey = resolveExpireKey(config.namespace)
+  const indexKey = resolveIndexKey(config.namespace)
+
+  const isExpired = localStorage.getItem(expireKey) < Date.now()
+
+  INDEXS = JSON.parse(localStorage.getItem(indexKey))
 
   if (isExpired) {
     INDEXS = {}
@@ -172,7 +188,7 @@ export function init(config, vm) {
       .get(vm.router.getFile(path), false, vm.config.requestHeaders)
       .then(result => {
         INDEXS[path] = genIndex(path, result, vm.router, config.depth)
-        len === ++count && saveData(config.maxAge)
+        len === ++count && saveData(config.maxAge, expireKey, indexKey)
       })
   })
 }

src/themes/basic/_layout.styl

@@ -323,6 +323,9 @@ body.sticky
 
 .markdown-section iframe
   border 1px solid #eee
+  /* fix horizontal overflow on iOS Safari */
+  width 1px
+  min-width 100%
 
 .markdown-section table
   border-collapse collapse
@@ -383,6 +386,9 @@ body.sticky
   border-radius 2px
   padding 1rem
 
+.markdown-section ul.task-list > li
+  list-style-type none
+
 body.close
   .sidebar
     transform translateX(- $sidebar-width)

src/themes/dolphin.styl

@@ -0,0 +1,228 @@
+@import url('https://fonts.googleapis.com/css?family=Thasadith:400,400i,700')
+
+$color-primary = #00ffff
+$color-bg = #f0ffff
+$color-text = #34495e
+$sidebar-width = 300px
+
+@import 'basic/_layout'
+@import 'basic/_coverpage'
+
+body
+  background-color $color-bg
+
+/* sidebar */
+.sidebar
+  background-color $color-bg
+  color #364149
+
+  li
+    margin 6px 0 6px 0
+
+  ul li a
+    color #505d6b
+    font-size 14px
+    font-weight normal
+    overflow hidden
+    text-decoration none
+    text-overflow ellipsis
+    white-space nowrap
+
+    &:hover
+      text-decoration underline
+
+  ul li ul
+    padding 0
+
+  ul li.active > a
+    border-right 2px solid
+    color var(--theme-color, $color-primary)
+    font-weight 600
+
+.app-sub-sidebar
+  li
+    &::before
+      content '-'
+      padding-right 4px
+      float left
+
+/* markdown content found on pages */
+.markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4, .markdown-section strong
+  color #2c3e50
+  font-weight 600
+
+.markdown-section a
+  color var(--theme-color, $color-primary)
+  font-weight 600
+  
+  &:hover
+      text-decoration underline
+
+.markdown-section h1
+  font-size 2rem
+  margin 0 0 1rem
+
+.markdown-section h2
+  font-size 1.75rem
+  margin 45px 0 0.8rem
+
+.markdown-section h3
+  font-size 1.5rem
+  margin 40px 0 0.6rem
+
+.markdown-section h4
+  font-size 1.25rem
+
+.markdown-section h5
+  font-size 1rem
+
+.markdown-section h6
+  color #777
+  font-size 1rem
+
+.markdown-section figure, .markdown-section p
+  margin 1.2em 0
+
+.markdown-section p, .markdown-section ul, .markdown-section ol
+  line-height 1.6rem
+  word-spacing 0.05rem
+
+.markdown-section ul, .markdown-section ol
+  padding-left 1.5rem
+
+.markdown-section blockquote
+  border-left 4px solid var(--theme-color, $color-primary)
+  color #858585
+  margin 2em 0
+  padding-left 20px
+
+.markdown-section blockquote p
+  font-weight 600
+  margin-left 0
+
+.markdown-section iframe
+  margin 1em 0
+
+.markdown-section em
+  color #7f8c8d
+
+.markdown-section code
+  background-color #f8f8f8
+  border-radius 2px
+  color #e96900
+  font-family 'Roboto Mono', Monaco, courier, monospace
+  font-size 0.8rem
+  margin 0 2px
+  padding 3px 5px
+  white-space pre-wrap
+
+.markdown-section pre
+  -moz-osx-font-smoothing initial
+  -webkit-font-smoothing initial
+  background-color #f8f8f8
+  font-family 'Roboto Mono', Monaco, courier, monospace
+  line-height 1.5rem
+  margin 1.2em 0
+  overflow auto
+  padding 0 1.4rem
+  position relative
+  word-wrap normal
+
+/* code highlight */
+.token.comment, .token.prolog, .token.doctype, .token.cdata
+  color #8e908c
+
+.token.namespace
+  opacity 0.7
+
+.token.boolean, .token.number
+  color #c76b29
+
+.token.punctuation
+  color #525252
+
+.token.property
+  color #c08b30
+
+.token.tag
+  color #2973b7
+
+.token.string
+  color var(--theme-color, $color-primary)
+
+.token.selector
+  color #6679cc
+
+.token.attr-name
+  color #2973b7
+
+.token.entity, .token.url, .language-css .token.string, .style .token.string
+  color #22a2c9
+
+.token.attr-value, .token.control, .token.directive, .token.unit
+  color var(--theme-color, $color-primary)
+
+.token.keyword, .token.function
+  color #e96900
+
+.token.statement, .token.regex, .token.atrule
+  color #22a2c9
+
+.token.placeholder, .token.variable
+  color #3d8fd1
+
+.token.deleted
+  text-decoration line-through
+
+.token.inserted
+  border-bottom 1px dotted #202746
+  text-decoration none
+
+.token.italic
+  font-style italic
+
+.token.important, .token.bold
+  font-weight bold
+
+.token.important
+  color #c94922
+
+.token.entity
+  cursor help
+
+.markdown-section pre > code
+  -moz-osx-font-smoothing initial
+  -webkit-font-smoothing initial
+  background-color #f8f8f8
+  border-radius 2px
+  color #525252
+  display block
+  font-family 'Roboto Mono', Monaco, courier, monospace
+  font-size 0.8rem
+  line-height inherit
+  margin 0 2px
+  max-width inherit
+  overflow inherit
+  padding 2.2em 5px
+  white-space inherit
+
+.markdown-section code::after, .markdown-section code::before
+  letter-spacing 0.05rem
+
+code .token
+  -moz-osx-font-smoothing initial
+  -webkit-font-smoothing initial
+  min-height 1.5rem
+
+pre::after
+  color #ccc
+  content attr(data-lang)
+  font-size 0.6rem
+  font-weight 600
+  height 15px
+  line-height 15px
+  padding 5px 10px 0
+  position absolute
+  right 0
+  text-align right
+  top 0

test/_helper.js

@@ -0,0 +1,87 @@
+// load ES6 modules in Node.js on the fly
+require = require('esm')(module/*, options*/)
+
+const path = require('path')
+const {expect} = require('chai')
+
+const {JSDOM} = require('jsdom')
+
+function ready(callback) {
+  const state = document.readyState
+
+  if (state === 'complete' || state === 'interactive') {
+    return setTimeout(callback, 0)
+  }
+
+  document.addEventListener('DOMContentLoaded', callback)
+}
+module.exports.init = function(fixture = 'default', config = {}, markup) {
+	if (markup == null) {
+		markup = `<!DOCTYPE html>
+		<html>
+		  <head></head>
+		  <body>
+		  	<div id="app"></div>
+		  	<script>
+		  		window.$docsify = ${JSON.stringify(config, null, 2)}
+		  	</script>
+		  </body>
+		</html>`
+	}
+	const rootPath = path.join(__dirname, 'fixtures', fixture)
+		
+	const dom = new JSDOM(markup) 
+	dom.reconfigure({ url: 'file:///' + rootPath })
+
+	global.window = dom.window
+	global.document = dom.window.document
+	global.navigator = dom.window.navigator
+	global.location = dom.window.location
+	global.XMLHttpRequest = dom.window.XMLHttpRequest
+
+	// mimic src/core/index.js but for Node.js
+	function Docsify() {
+	  this._init()
+	}
+
+	const proto = Docsify.prototype
+
+	const {initMixin} = require('../src/core/init')
+	const {routerMixin} = require('../src/core//router')
+	const {renderMixin} = require('../src/core//render')
+	const {fetchMixin} = require('../src/core/fetch')
+	const {eventMixin} = require('../src/core//event')
+
+	initMixin(proto)
+	routerMixin(proto)
+	renderMixin(proto)
+	fetchMixin(proto)
+	eventMixin(proto)
+
+	const NOT_INIT_PATTERN = '<!--main-->'
+
+	return new Promise((resolve, reject) => {
+		ready(() => {
+			const docsify = new Docsify()
+			// NOTE: I was not able to get it working with a callback, but polling works usually at the first time
+			const id = setInterval(() => {
+				if (dom.window.document.body.innerHTML.indexOf(NOT_INIT_PATTERN) == -1) {
+					clearInterval(id)
+					return resolve({
+						docsify: docsify,
+						dom: dom
+					})
+				}
+			}, 10)
+		})
+		
+	})
+}
+module.exports.expectSameDom = function(actual, expected) {
+	const WHITESPACES_BETWEEN_TAGS = />(\s\s+)</g
+	function replacer(match, group1) {
+		return match.replace(group1, '')
+	}
+	expect(actual.replace(WHITESPACES_BETWEEN_TAGS, replacer).trim())
+	.equal(expected.replace(WHITESPACES_BETWEEN_TAGS, replacer).trim())
+}

test/fixtures/default/README.md

@@ -0,0 +1,6 @@
+<!-- 
+
+create your own fixture directory
+if you need a custom README.md or sidebar
+
+-->

test/fixtures/simple/README.md

@@ -0,0 +1,18 @@
+# Heading
+
+[another page](other.md)
+
+## II 1
+
+### III 1
+
+#### IV 1
+
+##### V 1
+
+
+## II 2
+
+### III 2
+
+#### IV 2

test/fixtures/simple/other-page.md

@@ -0,0 +1,16 @@
+# Other
+
+## two 1
+
+### three 1
+
+#### four 1
+
+##### five 1 
+
+
+## two 2
+
+### three 2
+
+#### four 2

test/integration/render.js

@@ -0,0 +1,14 @@
+const path = require('path')
+
+const {expect} = require('chai')
+
+const {init, expectSameDom} = require('../_helper')
+
+describe('full docsify initialization', function() {
+	it('TODO: check generated markup', async function() {
+		const {docsify, dom} = await init('simple', {loadSidebar: true})
+  		console.log(dom.window.document.body.innerHTML)
+  		// TODO: add some expectations
+	})
+
+})

test/integration/router.js

@@ -0,0 +1,14 @@
+const path = require('path')
+
+const {expect} = require('chai')
+
+const {init, expectSameDom} = require('../_helper')
+
+describe('router', function() {
+	it('TODO: trigger to load another page', async function() {
+		const {docsify} = await init()
+  		window.location = '/?foo=bar'
+  		// TODO: add some expectations
+	})
+
+})

test/unit/base.js

@@ -0,0 +1,62 @@
+/* eslint-env node, chai, mocha */
+require = require('esm')(module/*, options*/)
+const {expect} = require('chai')
+const {History} = require('../../src/core/router/history/base')
+
+class MockHistory extends History {
+  parse(path) {
+    return {path}
+  }
+}
+
+describe('router/history/base', function () {
+  describe('relativePath true', function () {
+    var history
+
+    beforeEach(function () {
+      history = new MockHistory({relativePath: true})
+    })
+
+    it('toURL', function () {
+      // WHEN
+      const url = history.toURL('guide.md', {}, '/zh-ch/')
+
+      // THEN
+      expect(url).equal('/zh-ch/guide')
+    })
+
+    it('toURL with double dot', function () {
+      // WHEN
+      const url = history.toURL('../README.md', {}, '/zh-ch/')
+
+      // THEN
+      expect(url).equal('/README')
+    })
+
+    it('toURL child path', function () {
+      // WHEN
+      const url = history.toURL('config/example.md', {}, '/zh-ch/')
+
+      // THEN
+      expect(url).equal('/zh-ch/config/example')
+    })
+
+    it('toURL absolute path', function () {
+      // WHEN
+      const url = history.toURL('/README', {}, '/zh-ch/')
+
+      // THEN
+      expect(url).equal('/README')
+    })
+  })
+
+  it('toURL without relative path', function () {
+    const history = new MockHistory({relativePath: false})
+
+    // WHEN
+    const url = history.toURL('README', {}, '/zh-ch/')
+
+    // THEN
+    expect(url).equal('/README')
+  })
+})

test/unit/render.js

@@ -0,0 +1,89 @@
+const path = require('path')
+
+const {expect} = require('chai')
+
+const {init, expectSameDom} = require('../_helper')
+
+describe('render', function() {
+	it('important content (tips)', async function() {
+		const {docsify, dom} = await init()
+  		const output = docsify.compiler.compile('!> **Time** is money, my friend!')
+  		expect(output).equal('<p class="tip"><strong>Time</strong> is money, my friend!</p>')
+	})
+
+	describe('lists', function() {
+		it('as unordered task list', async function() {
+			const {docsify, dom} = await init()
+			const output = docsify.compiler.compile(`
+- [x] Task 1
+- [ ] Task 2
+- [ ] Task 3`)
+			expect(output, `<ul class="task-list">
+				<li class="task-list-item"><label><input checked="" disabled="" type="checkbox"> Task 1</label></li>
+				<li class="task-list-item"><label><input disabled="" type="checkbox"> Task 2</label></li>
+				<li class="task-list-item"><label><input disabled="" type="checkbox"> Task 3</label></li>
+			</ul>`)
+		})
+
+		it('as ordered task list', async function() {
+			const {docsify, dom} = await init()
+			const output = docsify.compiler.compile(`
+1. [ ] Task 1
+2. [x] Task 2`)
+			expectSameDom(output, `<ol class="task-list">
+				<li class="task-list-item"><label><input disabled="" type="checkbox"> Task 1</label></li>
+				<li class="task-list-item"><label><input checked="" disabled="" type="checkbox"> Task 2</label></li>
+			</ol>`)
+		})
+
+		it('normal unordered', async function() {
+			const {docsify, dom} = await init()
+			const output = docsify.compiler.compile(`
+- [linktext](link)
+- just text`)
+			expectSameDom(output, `<ul >
+				<li><a href="#/link">linktext</a></li>
+				<li>just text</li>
+			</ul>`)
+		})
+
+		it('unordered with custom start', async function() {
+			const {docsify, dom} = await init()
+			const output = docsify.compiler.compile(`
+1. first
+2. second
+
+text
+
+3. third`)
+			expectSameDom(output, `<ol >
+				<li>first</li>
+				<li>second</li>
+			</ol>
+			<p>text</p>
+			<ol start="3">
+			  <li>third</li>
+			</ol>`)
+		})
+
+		it('nested', async function() {
+			const {docsify, dom} = await init()
+			const output = docsify.compiler.compile(`
+- 1
+- 2
+  - 2 a
+  - 2 b
+- 3`)
+			expectSameDom(output, `<ul >
+				<li>1</li>
+				<li>2<ul >
+						<li>2 a</li>
+						<li>2 b</li>
+					</ul>
+				</li>
+				<li>3</li>
+			</ul>`)
+		})
+	})
+
+})

test/unit/util.js

@@ -0,0 +1,30 @@
+/* eslint-env node, chai, mocha */
+require = require('esm')(module/*, options*/)
+const {expect} = require('chai')
+const {resolvePath} = require('../../src/core/router/util')
+
+describe('router/util', function () {
+  it('resolvePath', async function () {
+    // WHEN
+    const result = resolvePath('hello.md')
+
+    // THEN
+    expect(result).equal('/hello.md')
+  })
+
+  it('resolvePath with dot', async function () {
+    // WHEN
+    const result = resolvePath('./hello.md')
+
+    // THEN
+    expect(result).equal('/hello.md')
+  })
+
+  it('resolvePath with two dots', async function () {
+    // WHEN
+    const result = resolvePath('test/../hello.md')
+
+    // THEN
+    expect(result).equal('/hello.md')
+  })
+})

themes/.gitkeep

@@ -0,0 +1 @@
+