[release] 4.2.0

[build] 4.2.0
chore: add changelog
2026-08-09 21:36:10 +10:00 · 2017-07-10 22:40:40 +08:00 · 2017-07-10 22:40:38 +08:00 · 2017-07-10 22:39:42 +08:00 · 2017-07-10 22:38:26 +08:00 · 2017-07-10 22:23:09 +08:00
36 changed files with 412 additions and 127 deletions
@@ -1,15 +1,45 @@
 # Changelog

+4.2.0 / 2017-07-10
+
+  * feat: ignore to compiled link, fixed #203 (#204)
+  * feat: alias option supports regexp, resolve #183
+
+4.1.14 / 2017-06-24
+
+  * feat: add context attribute, fixed #191
+  * fix: get file path
+  * Merge pull request #195 from crawt/master
+  * Filter picture
+  * Update doc for external link target (#194)
+
+4.1.13 / 2017-06-11
+
+  * fix ga
+
+4.1.12 / 2017-06-03
+
+  * fix(render): ubtitle in side bar shows undefined, fixed [#182](https://github.com/QingWei-Li/docsify/issues/182)
+
+4.1.11 / 2017-06-02
+
+  * fix(render): autoHeader does not work
+  * fix(compiler): force reset toc when rendering sidebar fixed [#181](https://github.com/QingWei-Li/docsify/issues/181)
+
+4.1.10 / 2017-06-02
+
+  * fix(hash): hash routing crashes when url has querystring
+
 4.1.9 / 2017-05-31

  * fix(lifecycle): continue to handle data
-  * fix: can't render toc on first load, fixed #171
-  * fix(render): broken name link, fixed #167
+  * fix: can't render toc on first load, fixed [#171](https://github.com/QingWei-Li/docsify/issues/171)
+  * fix(render): broken name link, fixed [#167](https://github.com/QingWei-Li/docsify/issues/167)

 ## 4.1.8(since 4.1.1) / 2017-05-31

-  * fix(pure-css):add coverpage style, fixed #165
-  * feat: add edit button demo, close #162
+  * fix(pure-css):add coverpage style, fixed [#165](https://github.com/QingWei-Li/docsify/issues/165)
+  * feat: add edit button demo, close [#162](https://github.com/QingWei-Li/docsify/issues/162)
  * fix some ssr bugs

 ## 4.1.0 / 2017-05-30 🎂 to me
@@ -11,7 +11,9 @@
 <p align="center">
  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/QingWei-Li/docsify/master.svg?style=flat-square"></a>
  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
+  <a href="https://cdnjs.com/libraries/docsify"><img alt="cdnjs" src="https://img.shields.io/cdnjs/v/docsify.svg?style=flat-square"></a>
  <a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
+  <a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=shield"/></a>
 </p>

 ## Links
@@ -22,7 +24,7 @@
 ## Features

 - No statically built html files
- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - Smart full-text search plugin
 - Multiple themes
 - Useful plugin API
@@ -40,12 +42,12 @@ Create an `index.html`.
 <html>
 <head>
  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
 </head>
 <body>
  <div id="app"></div>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
 </body>
-<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 </html>
 ```

@@ -55,7 +57,7 @@ Modern browsers and Internet Explorer 10+.

 ## Showcase

-These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
+These projects are using docsify to generate their sites. Pull requests welcome :blush:

 | Project | Description |
 |---|---|
@@ -68,6 +70,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
 | [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. |
 | [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. |
 | [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. |
+| [samlify](https://samlify.js.org) | Node.js SAML2 library |

 ## Similar projects

@@ -95,3 +98,5 @@ open http://localhost:3000
 ## License

 MIT
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large)
@@ -19,9 +19,7 @@
 <script>
  window.$docsify = {
    alias: {
-      '/de-de/changelog': '/changelog',
-      '/zh-cn/changelog': '/changelog',
-      '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+      '.*?/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
    },
    auto2top: true,
    basePath: '/docs/',
@@ -30,14 +28,13 @@
    loadSidebar: true,
    coverpage: true,
    name: 'docsify',
-    subMaxLevel: 2,
+    subMaxLevel: 0,
    mergeNavbar: true,
    formatUpdated: '{MM}/{DD} {HH}:{mm}',
-    routerMode: 'history',
    plugins: [
      function(hook, vm) {
        hook.beforeEach(function (html) {
-          var url = 'https://github.com/QingWei-Li/docsify/blob/master' + vm.router.getFile()
+          var url = 'https://github.com/QingWei-Li/docsify/blob/master/' + vm.route.file
          var editHtml = '[:memo: Edit Document](' + url + ')\n'

          return editHtml
@@ -11,7 +11,7 @@ See the [Quick start](quickstart.md) for more details.
 ## Features

 * No statically built html files
-* Simple and lightweight (~16kB gzipped)
+* Simple and lightweight (~18kB gzipped)
 * Smart full-text search plugin
 * Multiple themes
 * Useful plugin API
@@ -1,10 +1,10 @@
 ![logo](_media/icon.svg)

-# docsify <small>4.1.9</small>
+# docsify <small>4.2.0</small>

 > A magical documentation site generator.

- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - No statically built html files
 - Multiple themes

@@ -45,6 +45,6 @@ Alternatively, use [compressed files](#compressed-files).
 ## Other CDN

 - http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
 - https://cdnjs.com/libraries/docsify

@@ -250,11 +250,12 @@ window.$docsify = {

 - Type: `Object`

-Set the route alias. You can freely manage routing rules.
+Set the route alias. You can freely manage routing rules. Supports RegExp.

 ```js
 window.$docsify = {
  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
    '/zh-cn/changelog': '/changelog',
    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
  }
@@ -298,6 +299,8 @@ Note that if you are running an external script, e.g. an embedded jsfiddle demo,

 ## no-emoji

+- type: `Boolean`
+
 Disabled emoji parse.

 ```js
@@ -308,6 +311,8 @@ window.$docsify = {

 ## merge-navbar

+- type: `Boolean`
+
 Navbar will be merged with the sidebar on smaller screens.

 ```js
@@ -317,6 +322,9 @@ window.$docsify = {
 ```

 ## format-updated
+
+- type: `String|Function`
+
 We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`.
 See https://github.com/lukeed/tinydate#patterns
 ```js
@@ -333,7 +341,10 @@ window.$docsify = {

 ## external-link-target

-Currently it defaults to _blank, would be nice if configurable:
+- type: `String`
+- default: `_self`
+
+Target to open external links. Default `'_blank'` (new window/tab)

 ```js
 window.$docsify = {
@@ -342,8 +353,30 @@ window.$docsify = {
 ```

 ## router-mode
+
+- type: `String`
+- default: `history`
+
 ```js
 window.$docsify = {
  routerMode: 'history' // default: 'hash'
 }
 ```
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```
+
@@ -26,7 +26,7 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:

 > A magical documentation site generator.

- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - No statically built html files
 - Multiple themes

@@ -11,7 +11,7 @@ Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen.
 ## Features

 * keine generierten, statischen HTML Dateien
-* einfach und klein (~16kB gzipped)
+* einfach und klein (~18kB gzipped)
 * smarte Erweiterung mit Volltextsuche
 * mehrere Themes
 * praktische API für Erweiterungen
@@ -45,5 +45,5 @@ Alternativ kannst du auch die [komprimierten Dateien](#komprimierte-dateien) ver
 ## Andere CDN

 - http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
 - https://cdnjs.com/libraries/docsify
@@ -250,11 +250,12 @@ window.$docsify = {

 - Typ: `Object`

-Verwende alternative Routen. Du kannst sie ungehindert anpassen.
+Verwende alternative Routen. Du kannst sie ungehindert anpassen. Supports RegExp.

 ```js
 window.$docsify = {
  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
    '/zh-cn/changelog': '/changelog',
    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
  }
@@ -317,7 +318,7 @@ window.$docsify = {
 ```

 ## format-updated
-We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`. 
+We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`.
 See https://github.com/lukeed/tinydate#patterns
 ```js
 window.$docsify = {
@@ -340,3 +341,21 @@ window.$docsify = {
  externalLinkTarget: '_self' // default: '_blank'
 }
 ```
+
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```
@@ -26,7 +26,7 @@ Setze `coverpage` auf **true**, und erstelle `_coverpage.md`:

 > Ein magischer Generator für Dokumentationsseiten.

- Einfach und wenig Speicherbedarf (~16kB gzipped)
+- Einfach und wenig Speicherbedarf (~18kB gzipped)
 - Keine statischen HTML Dateien
 - Mehrere Themes

@@ -25,3 +25,27 @@ Generelle Tipps wie:
 wird wie folgt gerendert:

 ?> *TODO* unit test
+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
@@ -25,3 +25,28 @@ General tips like:
 are rendered as:

 ?> *TODO* unit test
+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
+
@@ -7,10 +7,10 @@
  <meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
  <meta name="description" content="A magical documentation generator.">
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" title="dark" disabled>
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="buble" disabled>
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css" title="pure" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/vue.css" title="vue">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/dark.css" title="dark" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/buble.css" title="buble" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/pure.css" title="pure" disabled>
  <style>
    nav.app-nav li ul {
      min-width: 100px;
@@ -23,9 +23,7 @@
 <script>
  window.$docsify = {
    alias: {
-      '/de-de/changelog': '/changelog',
-      '/zh-cn/changelog': '/changelog',
-      '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+      '.*?/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
    },
    auto2top: true,
    coverpage: true,
@@ -53,7 +51,7 @@
    plugins: [
      function(hook, vm) {
        hook.beforeEach(function (html) {
-          var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file
+          var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs/' + vm.route.file
          var editHtml = '[:memo: Edit Document](' + url + ')\n'

          return editHtml
@@ -66,9 +64,9 @@
    ]
  }
 </script>
-<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
-<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
-<script src="//unpkg.com/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 src="//cdn.jsdelivr.net/npm/docsify@latest/lib/docsify.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify@latest/lib/plugins/search.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
 </html>
@@ -12,7 +12,7 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo

 ## 特性
 - 无需构建，写完文档直接发布
- 容易使用并且轻量 (~16kB gzipped)
+- 容易使用并且轻量 (~18kB gzipped)
 - 智能的全文搜索
 - 提供多套主题
 - 丰富的 API
@@ -44,6 +44,6 @@ JS 的压缩文件是原有文件路径的基础上加 `.min`后缀

 ## 其他 CDN

- http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- http://www.bootcdn.cn/docsify (支持国内)
+- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
 - https://cdnjs.com/libraries/docsify
@@ -258,12 +258,13 @@ window.$docsify = {

 - 类型：`Object`

-定义路由别名，可以更自由的定义路由规则。
+定义路由别名，可以更自由的定义路由规则。 支持正则。


 ```js
 window.$docsify = {
  alias: {
+    '/foo/(+*)': '/bar/$1', // supports regexp
    '/zh-cn/changelog': '/changelog',
    '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
  }
@@ -327,7 +328,8 @@ window.$docsify = {
 ```

 ## format-updated
-我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`. 
+
+我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`.
 参考 https://github.com/lukeed/tinydate#patterns
 ```js
 window.$docsify = {
@@ -350,3 +352,21 @@ window.$docsify = {
  externalLinkTarget: '_self' // default: '_blank'
 }
 ```
+
+
+## noCompileLinks
+
+- type: `Array`
+
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/QingWei-Li/docsify/issues/203)
+
+
+```js
+window.$docsify = {
+  noCompileLinks: [
+    '/foo',
+    '/bar/.*'
+  ]
+}
+```
@@ -24,3 +24,28 @@ docsify 扩展了一些 Markdown 语法，可以让文档更易读。

 ?> *TODO* 完善示例

+
+## Ignore to compile link
+
+Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example
+
+```md
+[link](/demo/)
+```
+
+
+It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
+
+Now you can do that
+
+```md
+[link](/demo/ ":ignore")
+```
+You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
+
+```md
+[link](/demo/ ":ignore title")
+
+<a href="/demo/" title="title">link</a>
+```
+
@@ -8,4 +8,4 @@
 <script src="//unpkg.com/prismjs/components/prism-php.js"></script>
 ```

-?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)。
+?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)。
@@ -80,7 +80,8 @@ var config = merge({
  mergeNavbar: false,
  formatUpdated: '',
  externalLinkTarget: '_blank',
-  routerModel: 'hash'
+  routerModel: 'hash',
+  noCompileLinks: []
 }, window.$docsify);

 var script = document.currentScript ||
@@ -2717,8 +2718,9 @@ function parseQuery (query) {
  query.split('&').forEach(function (param) {
    var parts = param.replace(/\+/g, ' ').split('=');

-    res[parts[0]] = decode(parts[1]);
+    res[parts[0]] = parts[1] && decode(parts[1]);
  });
+
  return res
 }

@@ -2726,7 +2728,9 @@ function stringifyQuery (obj) {
  var qs = [];

  for (var key in obj) {
-    qs.push(((encode(key)) + "=" + (encode(obj[key]))).toLowerCase());
+    qs.push(obj[key]
+      ? ((encode(key)) + "=" + (encode(obj[key]))).toLowerCase()
+      : encode(key));
  }

  return qs.length ? ("?" + (qs.join('&'))) : ''
@@ -2757,6 +2761,8 @@ var cleanPath = cached(function (path) {
    .replace(/([^:])\/{2,}/g, '$1/')
 });

+var cachedLinks = {};
+
 var Compiler = function Compiler (config, router) {
  this.config = config;
  this.router = router;
@@ -2791,6 +2797,19 @@ var Compiler = function Compiler (config, router) {
  });
 };

+Compiler.prototype.matchNotCompileLink = function matchNotCompileLink (link) {
+  var links = this.config.noCompileLinks;
+
+  for (var i = 0; i < links.length; i++) {
+    var n = links[i];
+    var re = cachedLinks[n] || (cachedLinks[n] = new RegExp(("^" + n + "$")));
+
+    if (re.test(link)) {
+      return link
+    }
+  }
+};
+
 Compiler.prototype._initRenderer = function _initRenderer () {
  var renderer = new marked.Renderer();
  var ref = this;
@@ -2834,11 +2853,16 @@ Compiler.prototype._initRenderer = function _initRenderer () {
  };
  renderer.link = function (href, title, text) {
    var blank = '';
-    if (!/:|(\/{2})/.test(href)) {
+
+    if (!/:|(\/{2})/.test(href) &&
+      !_self.matchNotCompileLink(href) &&
+      !/(\s?:ignore)(\s\S+)?$/.test(title)) {
      href = router.toURL(href, null, router.getCurrentPath());
    } else {
      blank = " target=\"" + linkTarget + "\"";
+      title = title && title.replace(/:ignore/g, '').trim();
    }
+
    if (title) {
      title = " title=\"" + title + "\"";
    }
@@ -2889,6 +2913,10 @@ Compiler.prototype.sidebar = function sidebar (text, level) {
 * Compile sub sidebar
 */
 Compiler.prototype.subSidebar = function subSidebar (level) {
+  if (!level) {
+    this.toc = [];
+    return
+  }
  var currentPath = this.router.getCurrentPath();
  var ref = this;
    var cacheTree = ref.cacheTree;
@@ -3158,10 +3186,13 @@ function renderMixin (proto) {
    this._renderTo('.sidebar-nav', this.compiler.sidebar(text, maxLevel));
    var activeEl = getAndActive(this.router, '.sidebar-nav', true, true);
    if (loadSidebar && activeEl) {
-      activeEl.parentNode.innerHTML += this.compiler.subSidebar(subMaxLevel);
+      activeEl.parentNode.innerHTML += (this.compiler.subSidebar(subMaxLevel) || '');
+    } else {
+      // reset toc
+      this.compiler.subSidebar();
    }
    // bind event
-    this._bindEventOnRendered();
+    this._bindEventOnRendered(activeEl);
  };

  proto._bindEventOnRendered = function (activeEl) {
@@ -3193,6 +3224,10 @@ function renderMixin (proto) {
    var this$1 = this;
    if ( opt === void 0 ) opt = {};

+    if (!text) {
+      return renderMain.call(this, text)
+    }
+
    callHook(this, 'beforeEach', text, function (result) {
      var html = this$1.isHTML ? result : this$1.compiler.compile(result);
      if (opt.updatedAt) {
@@ -3291,8 +3326,15 @@ function initRender (vm) {
  toggleClass(body, 'ready');
 }

-function getAlias (path, alias) {
-  return alias[path] ? getAlias(alias[path], alias) : path
+var cached$1 = {};
+
+function getAlias (path, alias, last) {
+  var match = Object.keys(alias).filter(function (key) {
+    var re = cached$1[key] || (cached$1[key] = new RegExp(("^" + key + "$")));
+    return re.test(path) && path !== last
+  })[0];
+
+  return match ? getAlias(path.replace(cached$1[match], alias[match]), alias, path) : path
 }

 function getFileName (path) {
@@ -3311,7 +3353,7 @@ History.prototype.getBasePath = function getBasePath () {
  return this.config.basePath
 };

-History.prototype.getFile = function getFile (path) {
+History.prototype.getFile = function getFile (path, isRelative) {
  path = path || this.getCurrentPath();

  var ref = this;
@@ -3323,6 +3365,10 @@ History.prototype.getFile = function getFile (path) {
  path = path === '/README.md' ? (config.homepage || path) : path;
  path = isAbsolutePath(path) ? path : getPath(base, path);

+  if (isRelative) {
+    path = path.replace(new RegExp(("^" + base)), '');
+  }
+
  return path
 };

@@ -3403,20 +3449,20 @@ var HashHistory = (function (History$$1) {

    var query = '';

+    var hashIndex = path.indexOf('#');
+    if (hashIndex) {
+      path = path.slice(hashIndex + 1);
+    }
+
    var queryIndex = path.indexOf('?');
    if (queryIndex >= 0) {
      query = path.slice(queryIndex + 1);
      path = path.slice(0, queryIndex);
    }

-    var hashIndex = path.indexOf('#');
-    if (hashIndex) {
-      path = path.slice(hashIndex + 1);
-    }
-
    return {
      path: path,
-      file: this.getFile(path),
+      file: this.getFile(path, true),
      query: parseQuery(query)
    }
  };
@@ -3529,6 +3575,12 @@ function routerMixin (proto) {

 var lastRoute = {};

+function updateRender (vm) {
+  vm.router.normalize();
+  vm.route = vm.router.parse();
+  body.setAttribute('data-page', vm.route.file);
+}
+
 function initRouter (vm) {
  var config = vm.config;
  var mode = config.routerMode || 'hash';
@@ -3541,13 +3593,11 @@ function initRouter (vm) {
  }

  vm.router = router;
-
-  router.normalize();
-  lastRoute = vm.route = router.parse();
+  updateRender(vm);
+  lastRoute = vm.route;

  router.onchange(function (_) {
-    router.normalize();
-    vm.route = router.parse();
+    updateRender(vm);
    vm._updateRender();

    if (lastRoute.path === vm.route.path) {
@@ -3608,17 +3658,24 @@ function fetchMixin (proto) {
    // Current page is html
    this.isHTML = /\.html$/g.test(path);

-    // Load main content
-    last.then(function (text, opt) {
-      this$1._renderMain(text, opt);
+    var loadSideAndNav = function () {
      if (!loadSidebar) { return cb() }

      var fn = function (result) { this$1._renderSidebar(result); cb(); };

      // Load sidebar
      loadNested(path, loadSidebar, fn, this$1, true);
+    };
+
+    // Load main content
+    last.then(function (text, opt) {
+      this$1._renderMain(text, opt);
+      loadSideAndNav();
    },
-    function (_) { return this$1._renderMain(null); });
+    function (_) {
+      this$1._renderMain(null);
+      loadSideAndNav();
+    });

    // Load nav
    loadNavbar &&
@@ -3743,7 +3800,7 @@ initGlobalAPI();
 /**
 * Version
 */
-Docsify.version = '4.1.8';
+Docsify.version = '4.2.0';

 /**
 * Run Docsify
@@ -11,24 +11,21 @@ function appendScript () {
 }

 function init (id) {
-  var ga = window.ga;
-
-  if (!ga) {
-    appendScript();
-    ga = ga || function () {
-      (ga.q = ga.q || []).push(arguments);
-    };
-    ga.l = Number(new Date());
-    ga('create', id, 'auto');
-  }
-  return ga
+  appendScript();
+  window.ga = window.ga || function () {
+    (window.ga.q = window.ga.q || []).push(arguments);
+  };
+  window.ga.l = Number(new Date());
+  window.ga('create', id, 'auto');
 }

 function collect () {
-  var ga = init($docsify.ga);
+  if (!window.ga) {
+    init($docsify.ga);
+  }

-  ga('set', 'page', location.hash);
-  ga('send', 'pageview');
+  window.ga('set', 'page', location.hash);
+  window.ga('send', 'pageview');
 }

 var install = function (hook) {
@@ -1 +1 @@
-this.D=this.D||{},function(){"use strict";function n(){var n=document.createElement("script");n.async=!0,n.src="https://www.google-analytics.com/analytics.js",document.body.appendChild(n)}function c(c){var e=window.ga;return e||(n(),e=e||function(){(e.q=e.q||[]).push(arguments)},e.l=Number(new Date),e("create",c,"auto")),e}function e(){var n=c($docsify.ga);n("set","page",location.hash),n("send","pageview")}var i=function(n){if(!$docsify.ga)return void console.error("[Docsify] ga is required.");n.beforeEach(e)};$docsify.plugins=[].concat(i,$docsify.plugins)}();
+this.D=this.D||{},function(){"use strict";function n(){var n=document.createElement("script");n.async=!0,n.src="https://www.google-analytics.com/analytics.js",document.body.appendChild(n)}function i(i){n(),window.ga=window.ga||function(){(window.ga.q=window.ga.q||[]).push(arguments)},window.ga.l=Number(new Date),window.ga("create",i,"auto")}function o(){window.ga||i($docsify.ga),window.ga("set","page",location.hash),window.ga("send","pageview")}var a=function(n){if(!$docsify.ga)return void console.error("[Docsify] ga is required.");n.beforeEach(o)};$docsify.plugins=[].concat(a,$docsify.plugins)}();
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "4.1.8",
+  "version": "4.2.0",
  "lockfileVersion": 1,
  "dependencies": {
    "abbrev": {
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "4.1.9",
+  "version": "4.2.0",
  "description": "A magical documentation generator.",
  "author": {
    "name": "qingwei-li",
@@ -1,6 +1,6 @@
 {
  "name": "docsify-server-renderer",
-  "version": "4.1.8",
+  "version": "4.2.0",
  "description": "docsify server renderer",
  "author": {
    "name": "qingwei-li",
@@ -21,7 +21,8 @@ const config = merge({
  mergeNavbar: false,
  formatUpdated: '',
  externalLinkTarget: '_blank',
-  routerModel: 'hash'
+  routerModel: 'hash',
+  noCompileLinks: []
 }, window.$docsify)

 const script = document.currentScript ||
@@ -28,17 +28,24 @@ export function fetchMixin (proto) {
    // Current page is html
    this.isHTML = /\.html$/g.test(path)

-    // Load main content
-    last.then((text, opt) => {
-      this._renderMain(text, opt)
+    const loadSideAndNav = () => {
      if (!loadSidebar) return cb()

      const fn = result => { this._renderSidebar(result); cb() }

      // Load sidebar
      loadNested(path, loadSidebar, fn, this, true)
+    }
+
+    // Load main content
+    last.then((text, opt) => {
+      this._renderMain(text, opt)
+      loadSideAndNav()
    },
-    _ => this._renderMain(null))
+    _ => {
+      this._renderMain(null)
+      loadSideAndNav()
+    })

    // Load nav
    loadNavbar &&
@@ -7,6 +7,8 @@ import { emojify } from './emojify'
 import { isAbsolutePath, getPath } from '../router/util'
 import { isFn, merge, cached } from '../util/core'

+const cachedLinks = {}
+
 export class Compiler {
  constructor (config, router) {
    this.config = config
@@ -42,6 +44,19 @@ export class Compiler {
    })
  }

+  matchNotCompileLink (link) {
+    const links = this.config.noCompileLinks
+
+    for (var i = 0; i < links.length; i++) {
+      const n = links[i]
+      const re = cachedLinks[n] || (cachedLinks[n] = new RegExp(`^${n}$`))
+
+      if (re.test(link)) {
+        return link
+      }
+    }
+  }
+
  _initRenderer () {
    const renderer = new marked.Renderer()
    const { linkTarget, router, contentBase } = this
@@ -80,11 +95,16 @@ export class Compiler {
    }
    renderer.link = function (href, title, text) {
      let blank = ''
-      if (!/:|(\/{2})/.test(href)) {
+
+      if (!/:|(\/{2})/.test(href) &&
+        !_self.matchNotCompileLink(href) &&
+        !/(\s?:ignore)(\s\S+)?$/.test(title)) {
        href = router.toURL(href, null, router.getCurrentPath())
      } else {
        blank = ` target="${linkTarget}"`
+        title = title && title.replace(/:ignore/g, '').trim()
      }
+
      if (title) {
        title = ` title="${title}"`
      }
@@ -135,6 +155,10 @@ export class Compiler {
   * Compile sub sidebar
   */
  subSidebar (level) {
+    if (!level) {
+      this.toc = []
+      return
+    }
    const currentPath = this.router.getCurrentPath()
    const { cacheTree, toc } = this

@@ -84,10 +84,13 @@ export function renderMixin (proto) {
    this._renderTo('.sidebar-nav', this.compiler.sidebar(text, maxLevel))
    const activeEl = getAndActive(this.router, '.sidebar-nav', true, true)
    if (loadSidebar && activeEl) {
-      activeEl.parentNode.innerHTML += this.compiler.subSidebar(subMaxLevel)
+      activeEl.parentNode.innerHTML += (this.compiler.subSidebar(subMaxLevel) || '')
+    } else {
+      // reset toc
+      this.compiler.subSidebar()
    }
    // bind event
-    this._bindEventOnRendered()
+    this._bindEventOnRendered(activeEl)
  }

  proto._bindEventOnRendered = function (activeEl) {
@@ -114,6 +117,10 @@ export function renderMixin (proto) {
  }

  proto._renderMain = function (text, opt = {}) {
+    if (!text) {
+      return renderMain.call(this, text)
+    }
+
    callHook(this, 'beforeEach', text, result => {
      let html = this.isHTML ? result : this.compiler.compile(result)
      if (opt.updatedAt) {
@@ -1,8 +1,15 @@
 import { getPath, isAbsolutePath } from '../util'
 import { noop } from '../../util/core'

-function getAlias (path, alias) {
-  return alias[path] ? getAlias(alias[path], alias) : path
+const cached = {}
+
+function getAlias (path, alias, last) {
+  const match = Object.keys(alias).filter((key) => {
+    const re = cached[key] || (cached[key] = new RegExp(`^${key}$`))
+    return re.test(path) && path !== last
+  })[0]
+
+  return match ? getAlias(path.replace(cached[match], alias[match]), alias, path) : path
 }

 function getFileName (path) {
@@ -22,7 +29,7 @@ export class History {
    return this.config.basePath
  }

-  getFile (path) {
+  getFile (path, isRelative) {
    path = path || this.getCurrentPath()

    const { config } = this
@@ -33,6 +40,10 @@ export class History {
    path = path === '/README.md' ? (config.homepage || path) : path
    path = isAbsolutePath(path) ? path : getPath(base, path)

+    if (isRelative) {
+      path = path.replace(new RegExp(`^${base}`), '')
+    }
+
    return path
  }

@@ -58,20 +58,20 @@ export class HashHistory extends History {
  parse (path = location.href) {
    let query = ''

+    const hashIndex = path.indexOf('#')
+    if (hashIndex) {
+      path = path.slice(hashIndex + 1)
+    }
+
    const queryIndex = path.indexOf('?')
    if (queryIndex >= 0) {
      query = path.slice(queryIndex + 1)
      path = path.slice(0, queryIndex)
    }

-    const hashIndex = path.indexOf('#')
-    if (hashIndex) {
-      path = path.slice(hashIndex + 1)
-    }
-
    return {
      path,
-      file: this.getFile(path),
+      file: this.getFile(path, true),
      query: parseQuery(query)
    }
  }
@@ -1,6 +1,7 @@
 import { HashHistory } from './history/hash'
 import { HTML5History } from './history/html5'
 import { supportsPushState } from '../util/env'
+import * as dom from '../util/dom'

 export function routerMixin (proto) {
  proto.route = {}
@@ -8,6 +9,12 @@ export function routerMixin (proto) {

 let lastRoute = {}

+function updateRender (vm) {
+  vm.router.normalize()
+  vm.route = vm.router.parse()
+  dom.body.setAttribute('data-page', vm.route.file)
+}
+
 export function initRouter (vm) {
  const config = vm.config
  const mode = config.routerMode || 'hash'
@@ -20,13 +27,11 @@ export function initRouter (vm) {
  }

  vm.router = router
-
-  router.normalize()
-  lastRoute = vm.route = router.parse()
+  updateRender(vm)
+  lastRoute = vm.route

  router.onchange(_ => {
-    router.normalize()
-    vm.route = router.parse()
+    updateRender(vm)
    vm._updateRender()

    if (lastRoute.path === vm.route.path) {
@@ -16,8 +16,9 @@ export function parseQuery (query) {
  query.split('&').forEach(function (param) {
    const parts = param.replace(/\+/g, ' ').split('=')

-    res[parts[0]] = decode(parts[1])
+    res[parts[0]] = parts[1] && decode(parts[1])
  })
+
  return res
 }

@@ -25,7 +26,9 @@ export function stringifyQuery (obj) {
  const qs = []

  for (const key in obj) {
-    qs.push(`${encode(key)}=${encode(obj[key])}`.toLowerCase())
+    qs.push(obj[key]
+      ? `${encode(key)}=${encode(obj[key])}`.toLowerCase()
+      : encode(key))
  }

  return qs.length ? `?${qs.join('&')}` : ''
@@ -7,24 +7,21 @@ function appendScript () {
 }

 function init (id) {
-  let ga = window.ga
-
-  if (!ga) {
-    appendScript()
-    ga = ga || function () {
-      (ga.q = ga.q || []).push(arguments)
-    }
-    ga.l = Number(new Date())
-    ga('create', id, 'auto')
+  appendScript()
+  window.ga = window.ga || function () {
+    (window.ga.q = window.ga.q || []).push(arguments)
  }
-  return ga
+  window.ga.l = Number(new Date())
+  window.ga('create', id, 'auto')
 }

 function collect () {
-  const ga = init($docsify.ga)
+  if (!window.ga) {
+    init($docsify.ga)
+  }

-  ga('set', 'page', location.hash)
-  ga('send', 'pageview')
+  window.ga('set', 'page', location.hash)
+  window.ga('send', 'pageview')
 }

 const install = function (hook) {
Author	SHA1	Message	Date
qingwei.li	d9848c3384	[release] 4.2.0	2017-07-10 22:40:40 +08:00
qingwei.li	4dabae3bf2	[build] 4.2.0	2017-07-10 22:40:38 +08:00
qingwei.li	b430993f4f	chore: add changelog	2017-07-10 22:39:42 +08:00
cinwell.liandGitHub	2e00f4c993	feat: ignore to compiled link, fixed #203 (#204 ) * feat: ignore to compiled link, fixed #203 * feat: add noCompileLinks, fixed #203 * fix: remove test code	2017-07-10 22:38:26 +08:00
qingwei.li	7fb5ce6c84	docs: add alias	2017-07-10 22:23:09 +08:00
qingwei.li	c4aa22c56d	feat: alias option supports regexp, resolve #183	2017-07-10 22:19:55 +08:00
qingwei.li	9af855921e	fix: not found page	2017-07-09 10:48:41 +08:00
qingwei.li	4492c3e19f	[release] 4.1.14	2017-06-24 20:52:21 +08:00
qingwei.li	f598e53098	[build] 4.1.14	2017-06-24 20:52:21 +08:00
qingwei.li	4bde6d685c	add changelog	2017-06-24 20:51:53 +08:00
qingwei.li	ce0e9acd50	feat: add context attribute, fixed #191	2017-06-23 17:09:13 +08:00
qingwei.li	e8117e515d	fix: get file path, fixed jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070	2017-06-23 16:52:37 +08:00
cinwell.liandGitHub	25e09dfe07	Merge pull request #195 from crawt/master Filter picture	2017-06-18 02:19:14 +08:00
Leo PanandGitHub	a6b46a3e26	Filter picture use regular filter picturn in search	2017-06-16 16:45:21 +08:00
Kevin Leungandcinwell.li	d469442eae	Update doc for external link target (#194 )	2017-06-16 16:14:23 +08:00
qingwei.li	9f310bbd7d	[release] 4.1.13	2017-06-11 18:58:32 +08:00
qingwei.li	cc8a7c97b6	[build] 4.1.13	2017-06-11 18:58:31 +08:00
qingwei.li	19da658ba2	add changelog	2017-06-11 18:58:13 +08:00
qingwei.li	97db30a0b9	fix ga	2017-06-11 18:57:21 +08:00
Tony Nganandcinwell.li	3a0765e11e	add samlify (#189 )	2017-06-08 22:03:25 +08:00
Samina Fuandcinwell.li	aaf71b1ac0	Add CDNJS version badge in README.md (#185 ) This badge will show the version on CDNJS!	2017-06-06 12:44:33 +08:00
qingwei.li	b37781e949	[release] 4.1.12	2017-06-03 20:12:32 +08:00
qingwei.li	54a48dd3ff	[build] 4.1.12	2017-06-03 20:12:32 +08:00
qingwei.li	1aabc41db7	add changelog	2017-06-03 20:12:08 +08:00
qingwei.li	d087d5753b	fix(render): ubtitle in side bar shows undefined, fixed #182	2017-06-03 20:11:34 +08:00
qingwei.li	bb793ec08e	update package size	2017-06-02 22:37:27 +08:00
qingwei.li	6a78ae7ddc	[release] 4.1.11	2017-06-02 22:18:36 +08:00
qingwei.li	ac28040bd7	[build] 4.1.11	2017-06-02 22:18:36 +08:00
qingwei.li	b12f74b159	add changelog	2017-06-02 22:16:39 +08:00
qingwei.li	1304d2ea1a	fix(render): autoHeader does not work	2017-06-02 22:14:28 +08:00
qingwei.li	ccf4c7c5cc	fix(compiler): force reset toc when rendering sidebar fixed #181	2017-06-02 22:12:07 +08:00
qingwei.li	9b15d8d577	update cdn version	2017-06-02 18:04:20 +08:00
qingwei.li	642e7da7ee	[release] 4.1.10	2017-06-02 17:57:56 +08:00
qingwei.li	75381cf046	[build] 4.1.10	2017-06-02 17:57:56 +08:00
qingwei.li	7e2e5a7c90	add changelog	2017-06-02 17:57:32 +08:00
qingwei.li	6d48ce1266	fix(hash): hash routing crashes when url has querystring	2017-06-02 17:56:38 +08:00
qingwei.li	d286963da0	update readme	2017-06-02 17:41:13 +08:00
qingwei.li	8a4cedd962	replaced unpkg cdn with jsdelivr	2017-06-01 21:25:08 +08:00
Wei Wangandcinwell.li	a3b7b66a76	Fix broken footer (#178 )	2017-06-01 13:32:39 +08:00
qingwei.li	5a0d4b7897	docs(cdn): update jsdelivr cdn	2017-06-01 10:29:12 +08:00
Michelle Brierandcinwell.li	fcfdb17b8d	Add license scan badge (#176 )	2017-06-01 07:44:19 +08:00
Michelle Brierandcinwell.li	e4d2e7ec12	Add license report Large report badge	2017-06-01 07:43:59 +08:00