chore: add changelog 4.3.0

Nice documentation site generator! Thanks.

CHANGELOG.md

@@ -1,3 +1,61 @@
+<a name="4.3.0"></a>
+# [4.3.0](https://github.com/QingWei-Li/docsify/compare/v4.2.9...v4.3.0) (2017-08-17)
+
+
+### Features
+
+* **markdown:** supports mermaid [#137](https://github.com/QingWei-Li/docsify/issues/137) ([f4800e0](https://github.com/QingWei-Li/docsify/commit/f4800e0))
+
+
+
+<a name="4.2.9"></a>
+## [4.2.9](https://github.com/QingWei-Li/docsify/compare/v4.2.8...v4.2.9) (2017-08-15)
+
+
+### Bug Fixes
+
+* ensure document ready before init Docsify [#233](https://github.com/QingWei-Li/docsify/issues/233)
+
+<a name="4.2.8"></a>
+## [4.2.8](https://github.com/QingWei-Li/docsify/compare/v4.2.7...v4.2.8) (2017-08-10)
+
+
+### Features
+
+* **compiler:** support for setting target attribute for link, fixed [#230](https://github.com/QingWei-Li/docsify/issues/230) ([7f270f9](https://github.com/QingWei-Li/docsify/commit/7f270f9))
+
+
+
+<a name="4.2.7"></a>
+## [4.2.7](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.7) (2017-08-05)
+
+
+### Bug Fixes
+
+* **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+* **style:** nowrap => pre-wrap, fixed [#228](https://github.com/QingWei-Li/docsify/issues/228) ([a88252c](https://github.com/QingWei-Li/docsify/commit/a88252c))
+
+
+
+<a name="4.2.6"></a>
+## [4.2.6](https://github.com/QingWei-Li/docsify/compare/v4.2.4...v4.2.6) (2017-07-27)
+
+
+### Bug Fixes
+
+* **css:** hide the nav when the content has not yet been loaded ([1fa1619](https://github.com/QingWei-Li/docsify/commit/1fa1619))
+* **release:** release shell ([628e211](https://github.com/QingWei-Li/docsify/commit/628e211))
+
+
+
+<a name="4.2.4"></a>
+## [4.2.4](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.4) (2017-07-26)
+
+
+### Bug Fixes
+
+* **render:** Remove getRootNode to be compatible with the lower version of Chrome, fixed [#225](https://github.com/QingWei-Li/docsify/issues/225) ([b8dd346](https://github.com/QingWei-Li/docsify/commit/b8dd346))
+
 <a name="4.2.3"></a>
 ## [4.2.3](https://github.com/QingWei-Li/docsify/compare/v4.2.2...v4.2.3) (2017-07-26)
 

README.md

@@ -75,6 +75,7 @@ These projects are using docsify to generate their sites. Pull requests welcome
 | [palettify](https://dobromir-hristov.github.io/palettify/) | A color palette effects assistant |
 | [commitlint](https://marionebl.github.io/commitlint/) | Lint commit messages |
 | [vue-data-tables](https://github.com/njleonzhang/vue-data-tables/) | A simple and customizable data table，based on vue2 and element-ui. |
+| [Noty](http://ned.im/noty/) | A Dependency-free notification library |
 
 ## Similar projects
 

build/release.sh

@@ -30,15 +30,16 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
   # commit
   git add -A
   git commit -m "[build] $VERSION $RELEASE_TAG"
-  npm version $VERSION --message "[release] $VERSION $RELEASE_TAG"
+  npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
 
   # changelog
-  node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s -r 2
+  node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s
 
   git add .
   git commit -m "chore: add changelog $VERSION"
 
   # publish
+  git tag v$VERSION
   git push origin refs/tags/v$VERSION
   git push
   if [[ -z $RELEASE_TAG ]]; then

docs/_coverpage.md

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

docs/de-de/helpers.md

@@ -49,3 +49,10 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 
 <a href="/demo/" title="title">link</a>
 ```
+
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```

docs/de-de/markdown.md

@@ -28,3 +28,28 @@ window.$docsify = {
   }
 }
 ```
+
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```
+

docs/helpers.md

@@ -50,3 +50,10 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 <a href="/demo/" title="title">link</a>
 ```
 
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```
+

docs/markdown.md

@@ -28,3 +28,26 @@ window.$docsify = {
   }
 }
 ```
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```

docs/zh-cn/helpers.md

@@ -49,3 +49,10 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 <a href="/demo/" title="title">link</a>
 ```
 
+
+## Set target attribute for link
+
+```md
+[link](/demo ":target=_blank")
+[link](/demo2 ":target=_self")
+```

docs/zh-cn/markdown.md

@@ -27,4 +27,28 @@ window.$docsify = {
     return marked
   }
 }
-```
+```
+
+
+## Supports mermaid
+
+```js
+// Import mermaid
+//  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
+//  <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
+window.$docsify = {
+  markdown: {
+    renderer: {
+      code: function(code, lang) {
+        if (lang === "mermaid") {
+          return (
+            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
+          );
+        }
+        return this.origin.code.apply(this, arguments);
+      }
+    }
+  }
+}
+```

lib/docsify.js

@@ -2817,11 +2817,13 @@ Compiler.prototype._initRenderer = function _initRenderer () {
     var router = ref.router;
     var contentBase = ref.contentBase;
   var _self = this;
+  var origin = {};
+
   /**
    * render anchor tag
    * @link https://github.com/chjj/marked#overriding-renderer-methods
    */
-  renderer.heading = function (text, level) {
+  origin.heading = renderer.heading = function (text, level) {
     var nextToc = { level: level, title: text };
 
     if (/{docsify-ignore}/g.test(text)) {
@@ -2844,14 +2846,14 @@ Compiler.prototype._initRenderer = function _initRenderer () {
     return ("<h" + level + " id=\"" + slug + "\"><a href=\"" + url + "\" data-id=\"" + slug + "\" class=\"anchor\"><span>" + text + "</span></a></h" + level + ">")
   };
   // highlight code
-  renderer.code = function (code, lang) {
+  origin.code = renderer.code = function (code, lang) {
       if ( lang === void 0 ) lang = '';
 
     var hl = prism.highlight(code, prism.languages[lang] || prism.languages.markup);
 
     return ("<pre v-pre data-lang=\"" + lang + "\"><code class=\"lang-" + lang + "\">" + hl + "</code></pre>")
   };
-  renderer.link = function (href, title, text) {
+  origin.link = renderer.link = function (href, title, text) {
     var blank = '';
 
     if (!/:|(\/{2})/.test(href) &&
@@ -2863,12 +2865,19 @@ Compiler.prototype._initRenderer = function _initRenderer () {
       title = title && title.replace(/:ignore/g, '').trim();
     }
 
+    var target = title && title.match(/:target=\w+/);
+    if (target) {
+      target = target[0];
+      title = title.replace(target, '');
+      blank = ' ' + target.slice(1);
+    }
+
     if (title) {
       title = " title=\"" + title + "\"";
     }
     return ("<a href=\"" + href + "\"" + (title || '') + blank + ">" + text + "</a>")
   };
-  renderer.paragraph = function (text) {
+  origin.paragraph = renderer.paragraph = function (text) {
     if (/^!&gt;/.test(text)) {
       return helper('tip', text)
     } else if (/^\?&gt;/.test(text)) {
@@ -2876,7 +2885,7 @@ Compiler.prototype._initRenderer = function _initRenderer () {
     }
     return ("<p>" + text + "</p>")
   };
-  renderer.image = function (href, title, text) {
+  origin.image = renderer.image = function (href, title, text) {
     var url = href;
     var titleHTML = title ? (" title=\"" + title + "\"") : '';
 
@@ -2887,6 +2896,8 @@ Compiler.prototype._initRenderer = function _initRenderer () {
     return ("<img src=\"" + url + "\" data-origin=\"" + href + "\" alt=\"" + text + "\"" + titleHTML + ">")
   };
 
+  renderer.origin = origin;
+
   return renderer
 };
 
@@ -3782,6 +3793,19 @@ var initGlobalAPI = function () {
   window.Prism = prism;
 };
 
+/**
+ * Fork https://github.com/bendrucker/document-ready/blob/master/index.js
+ */
+function ready (callback) {
+  var state = document.readyState;
+
+  if (state === 'complete' || state === 'interactive') {
+    return setTimeout(callback, 0)
+  }
+
+  document.addEventListener('DOMContentLoaded', callback);
+}
+
 function Docsify () {
   this._init();
 }
@@ -3802,11 +3826,11 @@ initGlobalAPI();
 /**
  * Version
  */
-Docsify.version = '4.2.4';
+Docsify.version = '4.3.0';
 
 /**
  * Run Docsify
  */
-setTimeout(function (_) { return new Docsify(); }, 0);
+ready(function (_) { return new Docsify(); });
 
 }());

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.2.4",
+  "version": "4.3.0",
   "lockfileVersion": 1,
   "dependencies": {
     "abbrev": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.2.4",
+  "version": "4.3.0",
   "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.2.4"
+  "version": "4.3.0"
 }

packages/docsify-server-renderer/package.json

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

src/core/index.js

@@ -5,6 +5,19 @@ import { fetchMixin } from './fetch'
 import { eventMixin } from './event'
 import initGlobalAPI from './global-api'
 
+/**
+ * Fork https://github.com/bendrucker/document-ready/blob/master/index.js
+ */
+function ready (callback) {
+  const state = document.readyState
+
+  if (state === 'complete' || state === 'interactive') {
+    return setTimeout(callback, 0)
+  }
+
+  document.addEventListener('DOMContentLoaded', callback)
+}
+
 function Docsify () {
   this._init()
 }
@@ -30,4 +43,4 @@ Docsify.version = '__VERSION__'
 /**
  * Run Docsify
  */
-setTimeout(_ => new Docsify(), 0)
+ready(_ => new Docsify())

src/core/render/compiler.js

@@ -61,11 +61,13 @@ export class Compiler {
     const renderer = new marked.Renderer()
     const { linkTarget, router, contentBase } = this
     const _self = this
+    const origin = {}
+
     /**
      * render anchor tag
      * @link https://github.com/chjj/marked#overriding-renderer-methods
      */
-    renderer.heading = function (text, level) {
+    origin.heading = renderer.heading = function (text, level) {
       const nextToc = { level, title: text }
 
       if (/{docsify-ignore}/g.test(text)) {
@@ -88,12 +90,12 @@ export class Compiler {
       return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${text}</span></a></h${level}>`
     }
     // highlight code
-    renderer.code = function (code, lang = '') {
+    origin.code = renderer.code = function (code, lang = '') {
       const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
 
       return `<pre v-pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
     }
-    renderer.link = function (href, title, text) {
+    origin.link = renderer.link = function (href, title, text) {
       let blank = ''
 
       if (!/:|(\/{2})/.test(href) &&
@@ -105,12 +107,19 @@ export class Compiler {
         title = title && title.replace(/:ignore/g, '').trim()
       }
 
+      let target = title && title.match(/:target=\w+/)
+      if (target) {
+        target = target[0]
+        title = title.replace(target, '')
+        blank = ' ' + target.slice(1)
+      }
+
       if (title) {
         title = ` title="${title}"`
       }
       return `<a href="${href}"${title || ''}${blank}>${text}</a>`
     }
-    renderer.paragraph = function (text) {
+    origin.paragraph = renderer.paragraph = function (text) {
       if (/^!&gt;/.test(text)) {
         return helperTpl('tip', text)
       } else if (/^\?&gt;/.test(text)) {
@@ -118,7 +127,7 @@ export class Compiler {
       }
       return `<p>${text}</p>`
     }
-    renderer.image = function (href, title, text) {
+    origin.image = renderer.image = function (href, title, text) {
       let url = href
       const titleHTML = title ? ` title="${title}"` : ''
 
@@ -129,6 +138,8 @@ export class Compiler {
       return `<img src="${url}" data-origin="${href}" alt="${text}"${titleHTML}>`
     }
 
+    renderer.origin = origin
+
     return renderer
   }
 

src/themes/basic/_layout.css

@@ -10,7 +10,7 @@
 body:not(.ready) {
   overflow: hidden;
 
-  [data-cloak], .app-nav {
+  [data-cloak], .app-nav, > nav {
     display: none;
   }
 }
@@ -244,7 +244,7 @@ main {
       position: static;
     }
   }
-  
+
   .sidebar-nav {
     line-height: 2em;
   }

src/themes/buble.css

@@ -132,7 +132,7 @@ $sidebar-width: 16rem;
   border-radius: 3px;
   font-family: Inconsolata;
   padding: 0.2em 0.4rem;
-  white-space: pre;
+  white-space: nowrap;
 }
 
 .markdown-section pre {

src/themes/dark.css

@@ -134,7 +134,7 @@ body {
   font-size: 0.8rem;
   margin: 0 2px;
   padding: 3px 5px;
-  white-space: nowrap;
+  white-space: pre-wrap;
 }
 
 .markdown-section pre {

src/themes/vue.css

@@ -145,7 +145,7 @@ body {
   font-size: 0.8rem;
   margin: 0 2px;
   padding: 3px 5px;
-  white-space: nowrap;
+  white-space: pre-wrap;
 }
 
 .markdown-section pre {