-> v3.7.0

On https://docsify.js.org/#/quickstart

send "#/quickstart" instead of "https://docsify.js.org/#/quickstart"

CHANGELOG.md

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

README.md

@@ -64,6 +64,8 @@ These open-source projects are using docsify to generate their sites. Pull reque
 | [Vudash](http://vudash.github.io/vudash/) | Powerful, Flexible, Open Source dashboards for anything |
 | [Trilogy](http://trilogy.js.org) | No-hassle SQLite with a Promise-based, document store style API. |
 | [Mybatis-Plus](http://mp.baomidou.com/) | An enhanced toolkit of Mybatis to simplify development |
+| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. |
+| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. |
 
 ## Similar projects
 

app.js

@@ -4,7 +4,7 @@ var fs = require('fs')
 
 http.createServer(function (req, res) {
   serveStatic('.')(req, res, function () {
-    res.writeHead(404, { 'Content-Type': 'text/html' })
+    res.writeHead(200, { 'Content-Type': 'text/html' })
     res.end(fs.readFileSync('dev.html'))
   })
 }).listen(3000, '0.0.0.0')

dev.html

@@ -30,7 +30,15 @@
     loadSidebar: true,
     name: 'docsify',
     subMaxLevel: 2,
-    mergeNavbar: true
+    mergeNavbar: true,
+    formatUpdated: '{MM}/{DD} {HH}:{mm}',
+    plugins: [
+      function(hook) {
+        hook.beforeEach(function (html) {
+          return html += '> Last modified {docsify-updated}'
+        })
+      }
+    ]
   }
 </script>
 <script src="/lib/docsify.js"></script>

docs/cdn.md

@@ -44,4 +44,7 @@ Alternatively, use [compressed files](#compressed-files).
 
 ## Other CDN
 
-[jsDelivr](http://www.jsdelivr.com/projects/docsify) is available.
+- http://www.bootcdn.cn/docsify
+- http://www.jsdelivr.com/projects/docsify
+- https://cdnjs.com/libraries/docsify
+

docs/configuration.md

@@ -315,3 +315,28 @@ window.$docsify = {
   mergeNavbar: true
 }
 ```
+
+## format-updated
+We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`. 
+See https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+Currently it defaults to _blank, would be nice if configurable:
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```

docs/de-de/cdn.md

@@ -44,4 +44,6 @@ Alternativ kannst du auch die [komprimierten Dateien](#komprimierte-dateien) ver
 
 ## Andere CDN
 
-[jsDelivr](http://www.jsdelivr.com/projects/docsify) ist auch verfügbar.
+- http://www.bootcdn.cn/docsify
+- http://www.jsdelivr.com/projects/docsify
+- https://cdnjs.com/libraries/docsify

docs/de-de/configuration.md

@@ -314,4 +314,29 @@ Navbar will be merged with the sidebar on smaller screens.
 window.$docsify = {
   mergeNavbar: true
 }
-```
+```
+
+## format-updated
+We can display the file update date through **{docsify-updated<span>}</span>** variable. And format it by `formatUpdated`. 
+See https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+Currently it defaults to _blank, would be nice if configurable:
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```

docs/index.html

@@ -34,6 +34,7 @@
     loadNavbar: true,
     mergeNavbar: true,
     maxLevel: 4,
+    subMaxLevel: 2,
     name: 'docsify',
     search: {
       noData: {
@@ -48,7 +49,14 @@
         '/': 'Search'
       }
     },
-    subMaxLevel: 2
+    formatUpdated: '{MM}/{DD} {HH}:{mm}',
+    plugins: [
+      function(hook) {
+        hook.beforeEach(function (html) {
+          return html += '> Last modified {docsify-updated}'
+        })
+      }
+    ]
   }
 </script>
 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

docs/zh-cn/cdn.md

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

docs/zh-cn/configuration.md

@@ -326,3 +326,27 @@ window.$docsify = {
 }
 ```
 
+## format-updated
+我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`. 
+参考 https://github.com/lukeed/tinydate#patterns
+```js
+window.$docsify = {
+  formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+  formatUpdated: function (time) {
+    // ...
+
+    return time
+  }
+}
+```
+
+## external-link-target
+
+Currently it defaults to _blank, would be nice if configurable:
+
+```js
+window.$docsify = {
+  externalLinkTarget: '_self' // default: '_blank'
+}
+```

lib/docsify.js

@@ -77,7 +77,9 @@ var config = merge({
   executeScript: null,
   noEmoji: false,
   ga: '',
-  mergeNavbar: false
+  mergeNavbar: false,
+  formatUpdated: '',
+  externalLinkTarget: '_blank'
 }, window.$docsify);
 
 var script = document.currentScript ||
@@ -314,7 +316,9 @@ var getParentPath = cached(function (path) {
 });
 
 var cleanPath = cached(function (path) {
-  return path.replace(/\/+/g, '/')
+  return path
+    .replace(/^\/+/, '/')
+    .replace(/([^:])\/{2,}/g, '$1/')
 });
 
 function replaceHash (path) {
@@ -327,7 +331,7 @@ function replaceHash (path) {
 var replaceSlug = cached(function (path) {
   return path
     .replace('#', '?id=')
-    .replace(/\?(\w+)=/g, function (_, slug) { return slug === 'id' ? '?id=' : ("&" + slug + "="); })
+    // .replace(/\?(\w+)=/g, (_, slug) => slug === 'id' ? '?id=' : `&${slug}=`)
 });
 /**
  * Normalize the current url
@@ -627,9 +631,10 @@ function get (url, hasBar) {
   var on = function () {
     xhr.addEventListener.apply(xhr, arguments);
   };
+  var cached$$1 = cache[url];
 
-  if (cache[url]) {
-    return { then: function (cb) { return cb(cache[url]); }, abort: noop }
+  if (cached$$1) {
+    return { then: function (cb) { return cb(cached$$1.content, cached$$1.opt); }, abort: noop }
   }
 
   xhr.open('GET', url);
@@ -658,8 +663,14 @@ function get (url, hasBar) {
         if (target.status >= 400) {
           error(target);
         } else {
-          cache[url] = target.response;
-          success(target.response);
+          var result = cache[url] = {
+            content: target.response,
+            opt: {
+              updatedAt: xhr.getResponseHeader('last-modified')
+            }
+          };
+
+          success(result.content, result.opt);
         }
       });
     },
@@ -2957,6 +2968,7 @@ function emojify (text) {
 var markdownCompiler = marked;
 var contentBase = '';
 var currentPath = '';
+var linkTarget = '_blank';
 var renderer = new marked.Renderer();
 var cacheTree = {};
 var toc = [];
@@ -2978,11 +2990,13 @@ var markdown = cached(function (text) {
 
 markdown.renderer = renderer;
 
-markdown.init = function (config, base) {
+markdown.init = function (config, ref) {
   if ( config === void 0 ) config = {};
-  if ( base === void 0 ) base = window.location.pathname;
+  var base = ref.base; if ( base === void 0 ) base = window.location.pathname;
+  var externalLinkTarget = ref.externalLinkTarget;
 
   contentBase = getBasePath(base);
+  linkTarget = externalLinkTarget || linkTarget;
 
   if (isFn(config)) {
     markdownCompiler = config(marked, renderer);
@@ -3035,7 +3049,7 @@ renderer.link = function (href, title, text) {
   if (!/:|(\/{2})/.test(href)) {
     href = toURL(href, null, currentPath);
   } else {
-    blank = ' target="_blank"';
+    blank = " target=\"" + linkTarget + "\"";
   }
   if (title) {
     title = " title=\"" + title + "\"";
@@ -3116,6 +3130,45 @@ var render = Object.freeze({
 	cover: cover$1
 });
 
+var RGX = /([^{]*?)\w(?=\})/g;
+
+var dict = {
+	YYYY: 'getFullYear',
+	YY: 'getYear',
+	MM: function (d) {
+		return d.getMonth() + 1;
+	},
+	DD: 'getDate',
+	HH: 'getHours',
+	mm: 'getMinutes',
+	ss: 'getSeconds'
+};
+
+var tinydate = function (str) {
+	var parts=[], offset=0;
+	str.replace(RGX, function (key, _, idx) {
+		// save preceding string
+		parts.push(str.substring(offset, idx - 1));
+		offset = idx += key.length + 1;
+		// save function
+		parts.push(function(d){
+			return ('00' + (typeof dict[key]==='string' ? d[dict[key]]() : dict[key](d))).slice(-key.length);
+		});
+	});
+
+	if (offset !== str.length) {
+		parts.push(str.substring(offset));
+	}
+
+	return function (arg) {
+		var out='', i=0, d=arg||new Date();
+		for (; i<parts.length; i++) {
+			out += (typeof parts[i]==='string') ? parts[i] : parts[i](d);
+		}
+		return out;
+	};
+};
+
 function executeScript () {
   var script = findAll('.markdown-section>script')
       .filter(function (s) { return !/template/.test(s.type); })[0];
@@ -3128,6 +3181,16 @@ function executeScript () {
   }, 0);
 }
 
+function formatUpdated (html, updated, fn) {
+  updated = typeof fn === 'function'
+    ? fn(updated)
+    : typeof fn === 'string'
+      ? tinydate(fn)(new Date(updated))
+      : updated;
+
+  return html.replace(/{docsify-updated}/g, updated)
+}
+
 function renderMain (html) {
   if (!html) {
     // TODO: Custom 404 page
@@ -3208,11 +3271,13 @@ function renderMixin (proto) {
     getAndActive('nav');
   };
 
-  proto._renderMain = function (text) {
+  proto._renderMain = function (text, opt) {
     var this$1 = this;
 
     callHook(this, 'beforeEach', text, function (result) {
       var html = this$1.isHTML ? result : markdown(result);
+      html = formatUpdated(html, opt.updatedAt, this$1.config.formatUpdated);
+
       callHook(this$1, 'afterEach', html, function (text) { return renderMain.call(this$1, text); });
     });
   };
@@ -3260,7 +3325,7 @@ function initRender (vm) {
   var config = vm.config;
 
   // Init markdown compiler
-  markdown.init(config.markdown, config.basePath);
+  markdown.init(config.markdown, config);
 
   var id = config.el || '#app';
   var navEl = find('nav') || create('nav');
@@ -3404,8 +3469,8 @@ function fetchMixin (proto) {
     this.isHTML = /\.html$/g.test(path);
 
     // Load main content
-    last.then(function (text) {
-      this$1._renderMain(text);
+    last.then(function (text, opt) {
+      this$1._renderMain(text, opt);
       if (!loadSidebar) { return cb() }
 
       var fn = function (result) { this$1._renderSidebar(result); cb(); };

lib/plugins/external-script.js

@@ -4,15 +4,21 @@ this.D = this.D || {};
 
 function handleExternalScript () {
   var container = Docsify.dom.getNode('#main');
-  var script = Docsify.dom.find(container, 'script');
+  var scripts = Docsify.dom.findAll(container, 'script');
 
-  if (script && script.src) {
-    var newScript = document.createElement('script');['src', 'async', 'defer'].forEach(function (attribute) {
-      newScript[attribute] = script[attribute];
-    });
+  for (var i = scripts.length; i--;) {
+    var script = scripts[i];
 
-    script.parentNode.insertBefore(newScript, script);
-    script.parentNode.removeChild(script);
+    if (script && script.src) {
+      var newScript = document.createElement('script');
+
+      Array.prototype.slice.call(script.attributes).forEach(function (attribute) {
+        newScript[attribute.name] = attribute.value;
+      });
+
+      script.parentNode.insertBefore(newScript, script);
+      script.parentNode.removeChild(script);
+    }
   }
 }
 

lib/plugins/external-script.min.js

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

lib/plugins/ga.js

@@ -23,7 +23,7 @@ function init (id) {
 
 function collect () {
   init(window.$docsify.ga);
-  window.ga('set', 'page', location.href);
+  window.ga('set', 'page', location.hash);
   window.ga('send', 'pageview');
 }
 

lib/plugins/ga.min.js

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

lib/plugins/search.js

@@ -178,9 +178,11 @@ function style () {
   dom.appendTo(dom.head, style);
 }
 
-function tpl (opts) {
+function tpl (opts, defaultValue) {
+  if ( defaultValue === void 0 ) defaultValue = '';
+
   var html =
-    "<input type=\"search\" />" +
+    "<input type=\"search\" value=\"" + defaultValue + "\" />" +
       '<div class="results-panel"></div>' +
     '</div>';
   var el = dom.create('div', html);
@@ -190,26 +192,29 @@ function tpl (opts) {
   dom.before(aside, el);
 }
 
+function doSearch (value) {
+  var $search = dom.find('div.search');
+  var $panel = dom.find($search, '.results-panel');
+
+  if (!value) {
+    $panel.classList.remove('show');
+    $panel.innerHTML = '';
+    return
+  }
+  var matchs = search(value);
+
+  var html = '';
+  matchs.forEach(function (post) {
+    html += "<div class=\"matching-post\">\n<h2><a href=\"" + (post.url) + "\">" + (post.title) + "</a></h2>\n<p>" + (post.content) + "</p>\n</div>";
+  });
+
+  $panel.classList.add('show');
+  $panel.innerHTML = html || ("<p class=\"empty\">" + NO_DATA_TEXT + "</p>");
+}
+
 function bindEvents () {
   var $search = dom.find('div.search');
   var $input = dom.find($search, 'input');
-  var $panel = dom.find($search, '.results-panel');
-  var doSearch = function (value) {
-    if (!value) {
-      $panel.classList.remove('show');
-      $panel.innerHTML = '';
-      return
-    }
-    var matchs = search(value);
-
-    var html = '';
-    matchs.forEach(function (post) {
-      html += "<div class=\"matching-post\">\n  <h2><a href=\"" + (post.url) + "\">" + (post.title) + "</a></h2>\n  <p>" + (post.content) + "</p>\n</div>";
-    });
-
-    $panel.classList.add('show');
-    $panel.innerHTML = html || ("<p class=\"empty\">" + NO_DATA_TEXT + "</p>");
-  };
 
   var timeId;
   // Prevent to Fold sidebar
@@ -243,9 +248,12 @@ function updateNoData (text, path) {
 
 function init$$1 (opts) {
   dom = Docsify.dom;
+  var keywords = Docsify.route.parse().query.s;
+
   style();
-  tpl(opts);
+  tpl(opts, keywords);
   bindEvents();
+  keywords && setTimeout(function (_) { return doSearch(keywords); }, 500);
 }
 
 function update (opts, vm) {

lib/plugins/search.min.js

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "A magical documentation generator.",
   "author": {
     "name": "qingwei-li",
@@ -28,6 +28,7 @@
   "dependencies": {
     "marked": "^0.3.6",
     "prismjs": "^1.6.0",
+    "tinydate": "^1.0.0",
     "zoom-image": "^0.1.4"
   },
   "devDependencies": {

src/core/config.js

@@ -18,7 +18,9 @@ const config = merge({
   executeScript: null,
   noEmoji: false,
   ga: '',
-  mergeNavbar: false
+  mergeNavbar: false,
+  formatUpdated: '',
+  externalLinkTarget: '_blank'
 }, window.$docsify)
 
 const script = document.currentScript ||

src/core/fetch/ajax.js

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

src/core/fetch/index.js

@@ -28,8 +28,8 @@ export function fetchMixin (proto) {
     this.isHTML = /\.html$/g.test(path)
 
     // Load main content
-    last.then(text => {
-      this._renderMain(text)
+    last.then((text, opt) => {
+      this._renderMain(text, opt)
       if (!loadSidebar) return cb()
 
       const fn = result => { this._renderSidebar(result); cb() }

src/core/render/compiler.js

@@ -11,6 +11,7 @@ import { isFn, merge, cached } from '../util/core'
 let markdownCompiler = marked
 let contentBase = ''
 let currentPath = ''
+let linkTarget = '_blank'
 let renderer = new marked.Renderer()
 const cacheTree = {}
 let toc = []
@@ -32,8 +33,12 @@ export const markdown = cached(text => {
 
 markdown.renderer = renderer
 
-markdown.init = function (config = {}, base = window.location.pathname) {
+markdown.init = function (config = {}, {
+  base = window.location.pathname,
+  externalLinkTarget
+}) {
   contentBase = getBasePath(base)
+  linkTarget = externalLinkTarget || linkTarget
 
   if (isFn(config)) {
     markdownCompiler = config(marked, renderer)
@@ -84,7 +89,7 @@ renderer.link = function (href, title, text) {
   if (!/:|(\/{2})/.test(href)) {
     href = toURL(href, null, currentPath)
   } else {
-    blank = ' target="_blank"'
+    blank = ` target="${linkTarget}"`
   }
   if (title) {
     title = ` title="${title}"`

src/core/render/index.js

@@ -8,6 +8,7 @@ import { callHook } from '../init/lifecycle'
 import { getBasePath, getPath, isAbsolutePath } from '../route/util'
 import { isPrimitive } from '../util/core'
 import { isMobile } from '../util/env'
+import tinydate from 'tinydate'
 
 function executeScript () {
   const script = dom.findAll('.markdown-section>script')
@@ -21,6 +22,16 @@ function executeScript () {
   }, 0)
 }
 
+function formatUpdated (html, updated, fn) {
+  updated = typeof fn === 'function'
+    ? fn(updated)
+    : typeof fn === 'string'
+      ? tinydate(fn)(new Date(updated))
+      : updated
+
+  return html.replace(/{docsify-updated}/g, updated)
+}
+
 function renderMain (html) {
   if (!html) {
     // TODO: Custom 404 page
@@ -97,9 +108,11 @@ export function renderMixin (proto) {
     getAndActive('nav')
   }
 
-  proto._renderMain = function (text) {
+  proto._renderMain = function (text, opt) {
     callHook(this, 'beforeEach', text, result => {
-      const html = this.isHTML ? result : markdown(result)
+      let html = this.isHTML ? result : markdown(result)
+      html = formatUpdated(html, opt.updatedAt, this.config.formatUpdated)
+
       callHook(this, 'afterEach', html, text => renderMain.call(this, text))
     })
   }
@@ -147,7 +160,7 @@ export function initRender (vm) {
   const config = vm.config
 
   // Init markdown compiler
-  markdown.init(config.markdown, config.basePath)
+  markdown.init(config.markdown, config)
 
   const id = config.el || '#app'
   const navEl = dom.find('nav') || dom.create('nav')

src/core/route/hash.js

@@ -12,7 +12,7 @@ function replaceHash (path) {
 const replaceSlug = cached(path => {
   return path
     .replace('#', '?id=')
-    .replace(/\?(\w+)=/g, (_, slug) => slug === 'id' ? '?id=' : `&${slug}=`)
+    // .replace(/\?(\w+)=/g, (_, slug) => slug === 'id' ? '?id=' : `&${slug}=`)
 })
 /**
  * Normalize the current url

src/core/route/util.js

@@ -54,5 +54,7 @@ export const getParentPath = cached(path => {
 })
 
 export const cleanPath = cached(path => {
-  return path.replace(/\/+/g, '/')
+  return path
+    .replace(/^\/+/, '/')
+    .replace(/([^:])\/{2,}/g, '$1/')
 })

src/plugins/external-script.js

@@ -1,16 +1,20 @@
 function handleExternalScript () {
   const container = Docsify.dom.getNode('#main')
-  const script = Docsify.dom.find(container, 'script')
+  const scripts = Docsify.dom.findAll(container, 'script')
 
-  if (script && script.src) {
-    const newScript = document.createElement('script')
+  for (let i = scripts.length; i--;) {
+    const script = scripts[i]
 
-    ;['src', 'async', 'defer'].forEach(attribute => {
-      newScript[attribute] = script[attribute]
-    })
+    if (script && script.src) {
+      const newScript = document.createElement('script')
 
-    script.parentNode.insertBefore(newScript, script)
-    script.parentNode.removeChild(script)
+      Array.prototype.slice.call(script.attributes).forEach(attribute => {
+        newScript[attribute.name] = attribute.value
+      })
+
+      script.parentNode.insertBefore(newScript, script)
+      script.parentNode.removeChild(script)
+    }
   }
 }
 

src/plugins/ga.js

@@ -19,7 +19,7 @@ function init (id) {
 
 function collect () {
   init(window.$docsify.ga)
-  window.ga('set', 'page', location.href)
+  window.ga('set', 'page', location.hash)
   window.ga('send', 'pageview')
 }
 

src/plugins/search/component.js

@@ -69,9 +69,9 @@ function style () {
   dom.appendTo(dom.head, style)
 }
 
-function tpl (opts) {
+function tpl (opts, defaultValue = '') {
   const html =
-    `<input type="search" />` +
+    `<input type="search" value="${defaultValue}" />` +
       '<div class="results-panel"></div>' +
     '</div>'
   const el = dom.create('div', html)
@@ -81,29 +81,32 @@ function tpl (opts) {
   dom.before(aside, el)
 }
 
+function doSearch (value) {
+  const $search = dom.find('div.search')
+  const $panel = dom.find($search, '.results-panel')
+
+  if (!value) {
+    $panel.classList.remove('show')
+    $panel.innerHTML = ''
+    return
+  }
+  const matchs = search(value)
+
+  let html = ''
+  matchs.forEach(post => {
+    html += `<div class="matching-post">
+<h2><a href="${post.url}">${post.title}</a></h2>
+<p>${post.content}</p>
+</div>`
+  })
+
+  $panel.classList.add('show')
+  $panel.innerHTML = html || `<p class="empty">${NO_DATA_TEXT}</p>`
+}
+
 function bindEvents () {
   const $search = dom.find('div.search')
   const $input = dom.find($search, 'input')
-  const $panel = dom.find($search, '.results-panel')
-  const doSearch = function (value) {
-    if (!value) {
-      $panel.classList.remove('show')
-      $panel.innerHTML = ''
-      return
-    }
-    const matchs = search(value)
-
-    let html = ''
-    matchs.forEach(post => {
-      html += `<div class="matching-post">
-  <h2><a href="${post.url}">${post.title}</a></h2>
-  <p>${post.content}</p>
-</div>`
-    })
-
-    $panel.classList.add('show')
-    $panel.innerHTML = html || `<p class="empty">${NO_DATA_TEXT}</p>`
-  }
 
   let timeId
   // Prevent to Fold sidebar
@@ -137,9 +140,12 @@ function updateNoData (text, path) {
 
 export function init (opts) {
   dom = Docsify.dom
+  const keywords = Docsify.route.parse().query.s
+
   style()
-  tpl(opts)
+  tpl(opts, keywords)
   bindEvents()
+  keywords && setTimeout(_ => doSearch(keywords), 500)
 }
 
 export function update (opts, vm) {

src/plugins/search/index.js

@@ -9,7 +9,7 @@ const CONFIG = {
 }
 
 const install = function (hook, vm) {
-  const util = Docsify.util
+  const { util } = Docsify
   const opts = vm.config.search || CONFIG
 
   if (Array.isArray(opts)) {