chore: add changelog 4.5.0

[build] 4.5.0
fix lint
2026-08-10 13:56:12 +10:00 · 2017-11-04 13:56:25 +08:00 · 2017-11-04 13:56:24 +08:00 · 2017-11-04 13:56:08 +08:00 · 2017-11-04 13:54:37 +08:00 · 2017-11-02 10:48:09 +08:00
29 changed files with 286 additions and 364 deletions
@@ -1,3 +1,24 @@
+<a name="4.5.0"></a>
+# [4.5.0](https://github.com/QingWei-Li/docsify/compare/v4.4.1...v4.5.0) (2017-11-04)
+
+
+### Features
+
+* add disqus plugin, closed [#123](https://github.com/QingWei-Li/docsify/issues/123) ([fd7d4e0](https://github.com/QingWei-Li/docsify/commit/fd7d4e0))
+
+
+
+<a name="4.4.1"></a>
+## [4.4.1](https://github.com/QingWei-Li/docsify/compare/v4.4.0...v4.4.1) (2017-10-31)
+
+
+### Bug Fixes
+
+* {docsify-ignore-all} and {docsify-ignore} bug ([#299](https://github.com/QingWei-Li/docsify/issues/299)) ([cc98f56](https://github.com/QingWei-Li/docsify/commit/cc98f56))
+* zoom image plugin issue, fixed [#187](https://github.com/QingWei-Li/docsify/issues/187) ([#300](https://github.com/QingWei-Li/docsify/issues/300)) ([fa772cf](https://github.com/QingWei-Li/docsify/commit/fa772cf))
+
+
+
 <a name="4.4.0"></a>
 # [4.4.0](https://github.com/QingWei-Li/docsify/compare/v4.3.15...v4.4.0) (2017-10-30)

@@ -46,6 +46,7 @@ Create an `index.html`.
 <html>
 <head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
 </head>
@@ -48,7 +48,8 @@ var plugins = [
  { name: 'external-script', entry: 'external-script.js' },
  { name: 'front-matter', entry: 'front-matter/index.js' },
  { name: 'zoom-image', entry: 'zoom-image.js' },
-  { name: 'codesponsor', entry: 'codesponsor.js' }
+  { name: 'codesponsor', entry: 'codesponsor.js' },
+  { name: 'disqus', entry: 'disqus.js' }
 ]

 plugins.forEach(item => {
@@ -4,7 +4,7 @@
  <meta charset="UTF-8">
  <title>docsify</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
  <link rel="stylesheet" href="/themes/vue.css" title="vue">
  <link rel="stylesheet" href="/themes/dark.css" title="dark" disabled>
  <link rel="stylesheet" href="/themes/buble.css" title="buble" disabled>
@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)

-# docsify <small>4.4.0</small>
+# docsify <small>4.5.0</small>

 > A magical documentation site generator.

@@ -91,12 +91,18 @@ Wenn das Skript auf der Seite ein externes ist (eine Javascript Datei über das

 ## Bilder zoomen

-Medium's Bilderzoom. Basierend auf [zoom-image](https://github.com/egoist/zoom-image).
+Medium's Bilderzoom. Basierend auf [medium-zoom](https://github.com/francoischalifour/medium-zoom).

 ```html
 <script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
 ```

+Exclude the special image
+
+```markdown
+![](image.png ':no-zoom')
+```
+
 ## Edit on github

 Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
@@ -45,6 +45,7 @@ Wenn du `npm` nicht verwenden möchtest, oder Probleme bei der Installation des
 <html>
 <head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
@@ -91,12 +91,19 @@ If the script on the page is an external one (imports a js file via `src` attrib

 ## Zoom image

-Medium's Image Zoom. Based on [zoom-image](https://github.com/egoist/zoom-image).
+Medium's image zoom. Based on [medium-zoom](https://github.com/francoischalifour/medium-zoom).

 ```html
 <script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
 ```

+Exclude the special image
+
+```markdown
+![](image.png ':no-zoom')
+```
+
+
 ## Edit on github

 Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
@@ -140,3 +147,17 @@ window.$docsify = {
 ```

 See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details.
+
+
+## Disqus
+
+Disqus comments. https://disqus.com/
+
+```html
+<script>
+  window.$docsify = {
+    disqus: 'shortname'
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
+```
@@ -45,6 +45,7 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr
 <html>
 <head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
@@ -85,13 +85,21 @@

 ## 图片缩放 - Zoom image

-Medium's 风格的图片缩放插件. 基于 [zoom-image](https://github.com/egoist/zoom-image)。
+Medium's 风格的图片缩放插件. 基于 [medium-zoom](https://github.com/francoischalifour/medium-zoom)。

 ```html
 <script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
 ```


+忽略某张图片
+
+```markdown
+![](image.png ':no-zoom')
+```
+
+
+
 ## Edit on github

 Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
@@ -45,6 +45,7 @@ docsify serve docs
 <html>
 <head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
@@ -2794,6 +2794,22 @@ var cleanPath = cached(function (path) {
 });

 var cachedLinks = {};
+function getAndRemoveConfig (str) {
+  if ( str === void 0 ) str = '';
+
+  var config = {};
+
+  if (str) {
+    str = str
+      .replace(/:([\w-]+)=?([\w-]+)?/g, function (m, key, value) {
+        config[key] = value || true;
+        return ''
+      })
+      .trim();
+  }
+
+  return { str: str, config: config }
+}

 var Compiler = function Compiler (config, router) {
  this.config = config;
@@ -2894,16 +2910,11 @@ Compiler.prototype._initRenderer = function _initRenderer () {
      if ( title === void 0 ) title = '';

    var attrs = '';
-    var config = {};

-    if (title) {
-      title = title
-        .replace(/:(\w+)=?(\w+)?/g, function (m, key, value) {
-          config[key] = value || true;
-          return ''
-        })
-        .trim();
-    }
+    var ref = getAndRemoveConfig(title);
+      var str = ref.str;
+      var config = ref.config;
+    title = str;

    if (
      !/:|(\/{2})/.test(href) &&
@@ -2925,9 +2936,10 @@ Compiler.prototype._initRenderer = function _initRenderer () {
    }

    if (title) {
-      title = " title=\"" + title + "\"";
+      attrs += " title=\"" + title + "\"";
    }
-    return ("<a href=\"" + href + "\"" + (title || '') + attrs + ">" + text + "</a>")
+
+    return ("<a href=\"" + href + "\"" + attrs + ">" + text + "</a>")
  };
  origin.paragraph = renderer.paragraph = function (text) {
    if (/^!&gt;/.test(text)) {
@@ -2939,13 +2951,26 @@ Compiler.prototype._initRenderer = function _initRenderer () {
  };
  origin.image = renderer.image = function (href, title, text) {
    var url = href;
-    var titleHTML = title ? (" title=\"" + title + "\"") : '';
+    var attrs = '';
+
+    var ref = getAndRemoveConfig(title);
+      var str = ref.str;
+      var config = ref.config;
+    title = str;
+
+    if (config['no-zoom']) {
+      attrs += ' data-no-zoom';
+    }
+
+    if (title) {
+      attrs += " title=\"" + title + "\"";
+    }

    if (!isAbsolutePath(href)) {
      url = getPath(contentBase, href);
    }

-    return ("<img src=\"" + url + "\" data-origin=\"" + href + "\" alt=\"" + text + "\"" + titleHTML + ">")
+    return ("<img src=\"" + url + "\"data-origin=\"" + href + "\" alt=\"" + text + "\"" + attrs + ">")
  };

  renderer.origin = origin;
@@ -2985,11 +3010,12 @@ Compiler.prototype.subSidebar = function subSidebar (level) {
    var cacheTree = ref.cacheTree;
    var toc = ref.toc;

-  toc[0] && toc[0].ignoreAllSubs && (this.toc = []);
+  toc[0] && toc[0].ignoreAllSubs && toc.splice(0);
  toc[0] && toc[0].level === 1 && toc.shift();
-  toc.forEach(function (node, i) {
-    node.ignoreSubHeading && toc.splice(i, 1);
-  });
+
+  for (var i = 0; i < toc.length; i++) {
+    toc[i].ignoreSubHeading && toc.splice(i, 1) && i--;
+  }

  var tree$$1 = cacheTree[currentPath] || genTree(toc, level);

@@ -4010,7 +4036,7 @@ initGlobalAPI();
 /**
 * Version
 */
-Docsify.version = '4.4.0';
+Docsify.version = '4.5.0';

 /**
 * Run Docsify
@@ -0,0 +1,53 @@
+(function () {
+'use strict';
+
+location.href = location.href.replace('/-/', '/#/');
+
+function install (hook, vm) {
+  var dom = Docsify.dom;
+  var disqus = vm.config.disqus;
+  if (!disqus) {
+    throw Error('$docsify.disqus is required')
+  }
+
+  hook.init(function (_) {
+    var script = dom.create('script');
+
+    script.async = true;
+    script.src = "https://" + disqus + ".disqus.com/embed.js";
+    script.setAttribute('data-timestamp', +new Date());
+    dom.appendTo(dom.body, script);
+  });
+
+  hook.mounted(function (_) {
+    var div = dom.create('div');
+    div.id = 'disqus_thread';
+    var main = dom.getNode('#main');
+    div.style = "width: " + (main.clientWidth) + "px; margin: 0 auto 20px;";
+    dom.appendTo(dom.find('.content'), div);
+
+    // eslint-disable-next-line
+    window.disqus_config = function() {
+      this.page.url = location.origin + '/-' + vm.route.path;
+      this.page.identifier = vm.route.path;
+      this.page.title = document.title;
+    };
+  });
+
+  hook.doneEach(function (_) {
+    if (typeof window.DISQUS !== 'undefined') {
+      window.DISQUS.reset({
+        reload: true,
+        config: function () {
+          this.page.url = location.origin + '/-' + vm.route.path;
+          this.page.identifier = vm.route.path;
+          this.page.title = document.title;
+        }
+      });
+    }
+  });
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());
@@ -0,0 +1 @@
+!function(){"use strict";function i(i,t){var e=Docsify.dom,o=t.config.disqus;if(!o)throw Error("$docsify.disqus is required");i.init(function(i){var t=e.create("script");t.async=!0,t.src="https://"+o+".disqus.com/embed.js",t.setAttribute("data-timestamp",+new Date),e.appendTo(e.body,t)}),i.mounted(function(i){var o=e.create("div");o.id="disqus_thread";var n=e.getNode("#main");o.style="width: "+n.clientWidth+"px; margin: 0 auto 20px;",e.appendTo(e.find(".content"),o),window.disqus_config=function(){this.page.url=location.origin+"/-"+t.route.path,this.page.identifier=t.route.path,this.page.title=document.title}}),i.doneEach(function(i){void 0!==window.DISQUS&&window.DISQUS.reset({reload:!0,config:function(){this.page.url=location.origin+"/-"+t.route.path,this.page.identifier=t.route.path,this.page.title=document.title}})})}location.href=location.href.replace("/-/","/#/"),$docsify.plugins=[].concat(i,$docsify.plugins)}();
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "4.4.0",
+  "version": "4.5.0",
  "lockfileVersion": 1,
  "requires": true,
  "dependencies": {
@@ -4239,6 +4239,11 @@
      "integrity": "sha1-3oGf282E3M2PrlnGrreWFbnSZqw=",
      "dev": true
    },
+    "medium-zoom": {
+      "version": "0.2.0",
+      "resolved": "https://registry.npmjs.org/medium-zoom/-/medium-zoom-0.2.0.tgz",
+      "integrity": "sha512-2595M4GDwjoyZVDtkw6JWY8JxkhZVumqPjvM8coyRcULPZpoij2bQJ1/syqtx4XiflaqTva0cAch1kzqk0ir9Q=="
+    },
    "mem": {
      "version": "1.1.0",
      "resolved": "https://registry.npmjs.org/mem/-/mem-1.1.0.tgz",
@@ -7192,11 +7197,6 @@
          "dev": true
        }
      }
-    },
-    "zoom-image": {
-      "version": "0.1.4",
-      "resolved": "https://registry.npmjs.org/zoom-image/-/zoom-image-0.1.4.tgz",
-      "integrity": "sha1-+q8KgFG7Zya+YM891qM17HPx6Wk="
    }
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "4.4.0",
+  "version": "4.5.0",
  "description": "A magical documentation generator.",
  "author": {
    "name": "qingwei-li",
@@ -31,10 +31,10 @@
  },
  "dependencies": {
    "marked": "^0.3.6",
+    "medium-zoom": "^0.2.0",
    "prismjs": "^1.6.0",
    "tinydate": "^1.0.0",
-    "tweezer.js": "^1.4.0",
-    "zoom-image": "^0.1.4"
+    "tweezer.js": "^1.4.0"
  },
  "devDependencies": {
    "conventional-changelog-cli": "^1.3.2",
@@ -37,5 +37,5 @@
      "integrity": "sha1-6DWIAbhrg7F1YNTjw4LXrvIQCUQ="
    }
  },
-  "version": "4.4.0"
+  "version": "4.5.0"
 }
@@ -1,6 +1,6 @@
 {
  "name": "docsify-server-renderer",
-  "version": "4.4.0",
+  "version": "4.5.0",
  "description": "docsify server renderer",
  "author": {
    "name": "qingwei-li",
@@ -8,6 +8,20 @@ import { isAbsolutePath, getPath } from '../router/util'
 import { isFn, merge, cached } from '../util/core'

 const cachedLinks = {}
+function getAndRemoveConfig (str = '') {
+  const config = {}
+
+  if (str) {
+    str = str
+      .replace(/:([\w-]+)=?([\w-]+)?/g, (m, key, value) => {
+        config[key] = value || true
+        return ''
+      })
+      .trim()
+  }
+
+  return { str, config }
+}

 export class Compiler {
  constructor (config, router) {
@@ -102,16 +116,9 @@ export class Compiler {
    }
    origin.link = renderer.link = function (href, title = '', text) {
      let attrs = ''
-      const config = {}

-      if (title) {
-        title = title
-          .replace(/:(\w+)=?(\w+)?/g, (m, key, value) => {
-            config[key] = value || true
-            return ''
-          })
-          .trim()
-      }
+      const { str, config } = getAndRemoveConfig(title)
+      title = str

      if (
        !/:|(\/{2})/.test(href) &&
@@ -133,9 +140,10 @@ export class Compiler {
      }

      if (title) {
-        title = ` title="${title}"`
+        attrs += ` title="${title}"`
      }
-      return `<a href="${href}"${title || ''}${attrs}>${text}</a>`
+
+      return `<a href="${href}"${attrs}>${text}</a>`
    }
    origin.paragraph = renderer.paragraph = function (text) {
      if (/^!&gt;/.test(text)) {
@@ -147,13 +155,24 @@ export class Compiler {
    }
    origin.image = renderer.image = function (href, title, text) {
      let url = href
-      const titleHTML = title ? ` title="${title}"` : ''
+      let attrs = ''
+
+      const { str, config } = getAndRemoveConfig(title)
+      title = str
+
+      if (config['no-zoom']) {
+        attrs += ' data-no-zoom'
+      }
+
+      if (title) {
+        attrs += ` title="${title}"`
+      }

      if (!isAbsolutePath(href)) {
        url = getPath(contentBase, href)
      }

-      return `<img src="${url}" data-origin="${href}" alt="${text}"${titleHTML}>`
+      return `<img src="${url}"data-origin="${href}" alt="${text}"${attrs}>`
    }

    renderer.origin = origin
@@ -191,11 +210,12 @@ export class Compiler {
    const currentPath = this.router.getCurrentPath()
    const { cacheTree, toc } = this

-    toc[0] && toc[0].ignoreAllSubs && (this.toc = [])
+    toc[0] && toc[0].ignoreAllSubs && toc.splice(0)
    toc[0] && toc[0].level === 1 && toc.shift()
-    toc.forEach((node, i) => {
-      node.ignoreSubHeading && toc.splice(i, 1)
-    })
+
+    for (let i = 0; i < toc.length; i++) {
+      toc[i].ignoreSubHeading && toc.splice(i, 1) && i--
+    }

    const tree = cacheTree[currentPath] || genTree(toc, level)

@@ -0,0 +1,48 @@
+location.href = location.href.replace('/-/', '/#/')
+
+function install (hook, vm) {
+  const dom = Docsify.dom
+  const disqus = vm.config.disqus
+  if (!disqus) {
+    throw Error('$docsify.disqus is required')
+  }
+
+  hook.init(_ => {
+    const script = dom.create('script')
+
+    script.async = true
+    script.src = `https://${disqus}.disqus.com/embed.js`
+    script.setAttribute('data-timestamp', +new Date())
+    dom.appendTo(dom.body, script)
+  })
+
+  hook.mounted(_ => {
+    const div = dom.create('div')
+    div.id = 'disqus_thread'
+    const main = dom.getNode('#main')
+    div.style = `width: ${main.clientWidth}px; margin: 0 auto 20px;`
+    dom.appendTo(dom.find('.content'), div)
+
+    // eslint-disable-next-line
+    window.disqus_config = function() {
+      this.page.url = location.origin + '/-' + vm.route.path
+      this.page.identifier = vm.route.path
+      this.page.title = document.title
+    }
+  })
+
+  hook.doneEach(_ => {
+    if (typeof window.DISQUS !== 'undefined') {
+      window.DISQUS.reset({
+        reload: true,
+        config: function () {
+          this.page.url = location.origin + '/-' + vm.route.path
+          this.page.identifier = vm.route.path
+          this.page.title = document.title
+        }
+      })
+    }
+  })
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)
@@ -1,22 +1,14 @@
-import zoom from 'zoom-image'
-import style from 'zoom-image/css/zoom-image.css'
+import mediumZoom from 'medium-zoom'

 function install (hook) {
-  const dom = Docsify.dom
-  let destroys
-
-  // add style
-  dom.appendTo(dom.head, dom.create('style', style))
+  let zoom

  hook.doneEach(_ => {
-    const images = dom.findAll('img:not(.emoji)')
-
-    if (Array.isArray(destroys) && destroys.length) {
-      destroys.forEach(o => o())
-      destroys = []
+    if (zoom) {
+      zoom.detach()
    }

-    destroys = images.map(zoom)
+    zoom = mediumZoom('img:not(.emoji):not([data-no-zoom])')
  })
 }

@@ -212,6 +212,7 @@ main {
  display: block;
  position: relative;
  size: 100vw 100%;
+  z-index: 0;
 }

 .anchor {
@@ -450,10 +451,7 @@ body.close {
@media print {
  .github-corner,
  .sidebar-toggle,
-  .sidebar {
-    display: none;
-  }
-
+  .sidebar,
  .app-nav {
    display: none;
  }
Author	SHA1	Message	Date
qingwei.li	f27ce7d2b2	chore: add changelog 4.5.0	2017-11-04 13:56:25 +08:00
qingwei.li	2e1a7367a8	[build] 4.5.0	2017-11-04 13:56:24 +08:00
qingwei.li	7510f75968	fix lint	2017-11-04 13:56:08 +08:00
qingwei.li	fd7d4e0e4e	feat: add disqus plugin, closed #123	2017-11-04 13:54:37 +08:00
qingwei.li	025bc5cddf	chore: update all plugins.md, fixed #187	2017-11-02 10:48:09 +08:00
cinwell.liandGitHub	8f1066a035	chore: update doc fixed #187	2017-11-01 21:43:09 -05:00
qingwei.li	800c0c503a	chore: add changelog 4.4.1	2017-10-31 21:48:15 +08:00
qingwei.li	d5194b4f6b	[build] 4.4.1	2017-10-31 21:48:15 +08:00
cinwell.liandGitHub	fa772cfa94	fix: zoom image plugin issue, fixed #187 (#300 )	2017-10-31 08:20:08 -05:00
Li Xueliandcinwell.li	cc98f56cdd	fix: {docsify-ignore-all} and {docsify-ignore} bug (#299 ) * fix {docsify-ignore-all} not work bug * fix {docsify-ignore} bug	2017-10-31 08:19:48 -05:00
Li Xueliandcinwell.li	752f68e5f8	chore: {docsify-ignore-all} not working properly (#298 )	2017-10-31 03:11:40 -05:00
qingwei.li	bde17e1f10	chore: update template	2017-10-30 21:58:33 +08:00
				`@@ -0,0 +1 @@`
				!function(){"use strict";function i(i,t){var e=Docsify.dom,o=t.config.disqus;if(!o)throw Error("$docsify.disqus is required");i.init(function(i){var t=e.create("script");t.async=!0,t.src="https://"+o+".disqus.com/embed.js",t.setAttribute("data-timestamp",+new Date),e.appendTo(e.body,t)}),i.mounted(function(i){var o=e.create("div");o.id="disqus_thread";var n=e.getNode("#main");o.style="width: "+n.clientWidth+"px; margin: 0 auto 20px;",e.appendTo(e.find(".content"),o),window.disqus_config=function(){this.page.url=location.origin+"/-"+t.route.path,this.page.identifier=t.route.path,this.page.title=document.title}}),i.doneEach(function(i){void 0!==window.DISQUS&&window.DISQUS.reset({reload:!0,config:function(){this.page.url=location.origin+"/-"+t.route.path,this.page.identifier=t.route.path,this.page.title=document.title}})})}location.href=location.href.replace("/-/","/#/"),$docsify.plugins=[].concat(i,$docsify.plugins)}();