chore: add changelog 4.5.3

CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="4.5.3"></a>
+## [4.5.3](https://github.com/QingWei-Li/docsify/compare/v4.5.2...v4.5.3) (2017-11-11)
+
+
+### Features
+
+* add gitalk plugin ([#306](https://github.com/QingWei-Li/docsify/issues/306)) ([9208e64](https://github.com/QingWei-Li/docsify/commit/9208e64))
+
+
+
+<a name="4.5.2"></a>
+## [4.5.2](https://github.com/QingWei-Li/docsify/compare/v4.5.1...v4.5.2) (2017-11-09)
+
+
+### Features
+
+* github task lists, close [#215](https://github.com/QingWei-Li/docsify/issues/215) ([#305](https://github.com/QingWei-Li/docsify/issues/305)) ([d486eef](https://github.com/QingWei-Li/docsify/commit/d486eef))
+
+
+
 <a name="4.5.1"></a>
 ## [4.5.1](https://github.com/QingWei-Li/docsify/compare/v4.5.0...v4.5.1) (2017-11-07)
 

build/build.js

@@ -49,7 +49,8 @@ var plugins = [
   { name: 'front-matter', entry: 'front-matter/index.js' },
   { name: 'zoom-image', entry: 'zoom-image.js' },
   { name: 'codesponsor', entry: 'codesponsor.js' },
-  { name: 'disqus', entry: 'disqus.js' }
+  { name: 'disqus', entry: 'disqus.js' },
+  { name: 'gitalk', entry: 'gitalk.js' }
 ]
 
 plugins.forEach(item => {

docs/_coverpage.md

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

docs/de-de/helpers.md

@@ -56,3 +56,23 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 [link](/demo ":target=_blank")
 [link](/demo2 ":target=_self")
 ```
+
+
+## Github Task Lists
+
+```md
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim
+```
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim

docs/helpers.md

@@ -62,3 +62,23 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 ```md
 [link](/demo ":disabled")
 ```
+
+## Github Task Lists
+
+```md
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim
+```
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim
+

docs/plugins.md

@@ -161,3 +161,25 @@ Disqus comments. https://disqus.com/
 </script>
 <script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
 ```
+
+## Gitalk
+
+Gitalk is a modern comment component based on Github Issue and Preact. https://github.com/gitalk/gitalk
+
+```html
+<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">
+
+<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
+<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
+<script>
+  const gitalk = new Gitalk({
+    clientID: 'Github Application Client ID',
+    clientSecret: 'Github Application Client Secret',
+    repo: 'Github repo',
+    owner: 'Github repo owner',
+    admin: ['Github repo collaborators, only these guys can initialize github issues'],
+    // facebook-like distraction free mode
+    distractionFreeMode: false
+  })
+</script>
+```

docs/zh-cn/helpers.md

@@ -56,3 +56,23 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 [link](/demo ":target=_blank")
 [link](/demo2 ":target=_self")
 ```
+
+
+## Github Task Lists
+
+```md
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim
+```
+
+* [ ] foo
+ * bar
+ * [x] baz
+ * [] bam
+   * [ ] bim
+   * [ ] lim

lib/docsify.js

@@ -2976,6 +2976,15 @@ Compiler.prototype._initRenderer = function _initRenderer () {
     return ("<img src=\"" + url + "\"data-origin=\"" + href + "\" alt=\"" + text + "\"" + attrs + ">")
   };
 
+  var CHECKED_RE = /^\[([ x])\] +/;
+  origin.listitem = renderer.listitem = function (text) {
+    var checked = CHECKED_RE.exec(text);
+    if (checked) {
+      text = text.replace(CHECKED_RE, ("<input type=\"checkbox\" " + (checked[1] === 'x' ? 'checked' : '') + " />"));
+    }
+    return ("<li>" + text + "</li>\n")
+  };
+
   renderer.origin = origin;
 
   return renderer
@@ -4054,7 +4063,7 @@ initGlobalAPI();
 /**
  * Version
  */
-Docsify.version = '4.5.1';
+Docsify.version = '4.5.3';
 
 /**
  * Run Docsify

lib/plugins/gitalk.js

@@ -0,0 +1,22 @@
+(function () {
+'use strict';
+
+function install (hook, vm) {
+  var dom = Docsify.dom;
+
+  hook.mounted(function (_) {
+    var div = dom.create('div');
+    div.id = 'gitalk-container';
+    var main = dom.getNode('#main');
+    div.style = "width: " + (main.clientWidth) + "px; margin: 0 auto 20px;";
+    dom.appendTo(dom.find('.content'), div);
+    var script = dom.create('script');
+    var content = "gitalk.render('gitalk-container')";
+    script.textContent = content;
+    dom.appendTo(dom.body, script);
+  });
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/gitalk.min.js

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

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.5.1",
+  "version": "4.5.3",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.5.1",
+  "version": "4.5.3",
   "description": "A magical documentation generator.",
   "author": {
     "name": "qingwei-li",

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

@@ -37,5 +37,5 @@
       "integrity": "sha1-6DWIAbhrg7F1YNTjw4LXrvIQCUQ="
     }
   },
-  "version": "4.5.1"
+  "version": "4.5.3"
 }

packages/docsify-server-renderer/package.json

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

src/core/render/compiler.js

@@ -175,6 +175,15 @@ export class Compiler {
       return `<img src="${url}"data-origin="${href}" alt="${text}"${attrs}>`
     }
 
+    const CHECKED_RE = /^\[([ x])\] +/
+    origin.listitem = renderer.listitem = function (text) {
+      const checked = CHECKED_RE.exec(text)
+      if (checked) {
+        text = text.replace(CHECKED_RE, `<input type="checkbox" ${checked[1] === 'x' ? 'checked' : ''} />`)
+      }
+      return `<li>${text}</li>\n`
+    }
+
     renderer.origin = origin
 
     return renderer

src/plugins/gitalk.js

@@ -0,0 +1,17 @@
+function install (hook, vm) {
+  const dom = Docsify.dom
+
+  hook.mounted(_ => {
+    const div = dom.create('div')
+    div.id = 'gitalk-container'
+    const main = dom.getNode('#main')
+    div.style = `width: ${main.clientWidth}px; margin: 0 auto 20px;`
+    dom.appendTo(dom.find('.content'), div)
+    const script = dom.create('script')
+    const content = `gitalk.render('gitalk-container')`
+    script.textContent = content
+    dom.appendTo(dom.body, script)
+  })
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)

src/themes/basic/_layout.css

@@ -91,6 +91,11 @@ kbd {
   vertical-align: middle;
 }
 
+li input[type=checkbox] {
+  margin: 0 0.2em 0.25em -1.6em;
+  vertical-align: middle;
+}
+
 /* navbar */
 .app-nav {
   left: 0;

src/themes/vue.css

@@ -100,9 +100,7 @@ body {
 }
 
 .markdown-section figure,
-.markdown-section p,
-.markdown-section ul,
-.markdown-section ol {
+.markdown-section p {
   margin: 1.2em 0;
 }