-> v3.4.0

add external-script plugin

CHANGELOG.md

@@ -1,28 +1,42 @@
 
+3.4.0 / 2017-03-09
+==================
+
+  * feat(zoom-image): add plugin
+
+3.3.0 / 2017-03-07
+==================
+
+  * add front-matter plugin
+  * add external-script plugin
+  * Fix nav showing while loading (#112)
+  * Fix a typo (#111)
+  * Update changelog
+
 3.2.0 / 2017-02-28
 ==================
 
-  * fix(render): Toc rendering error, fixed #106
-  * feat(search): Localization for no data tip, close #103
-  * fix(fetch): load sidebar and navbar for parent path, fixed #100
-  * feat(render) nameLink for each route, fixed #99
+  * 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
 ==================
 
-  * fix(search): dont search nameLink, fixed #102
+  * fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
 
 3.1.1 / 2017-02-24
 ==================
 
-  * fix(search): dont search nameLink, fixed #102
+  * 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
+  * fix(tpl): extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101)
 
 3.1.0 / 2017-02-22
 ==================
 
-  * fix(search): incorrect anchor link, fixed #90
+  * 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
@@ -30,8 +44,8 @@
 
   * feat(pwa): add sw.js
   * fix(layout.css): loading style
-  * fix(event): highlight sidebar when clicked, fixed #86
-  * fix(gen-tree): cache toc list, fixed #88
+  * 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
 ==================

build/build.js

@@ -2,6 +2,7 @@ var rollup = require('rollup')
 var buble = require('rollup-plugin-buble')
 var commonjs = require('rollup-plugin-commonjs')
 var nodeResolve = require('rollup-plugin-node-resolve')
+var string = require('rollup-plugin-string')
 var uglify = require('rollup-plugin-uglify')
 var isProd = process.argv[process.argv.length - 1] !== '--dev'
 
@@ -9,7 +10,12 @@ var build = function (opts) {
   rollup
     .rollup({
       entry: 'src/' + opts.entry,
-      plugins: [buble(), commonjs(), nodeResolve()].concat(opts.plugins || [])
+      plugins: (opts.plugins || []).concat([
+        string({ include: '**/*.css' }),
+        buble(),
+        commonjs(),
+        nodeResolve()
+      ])
     })
     .then(function (bundle) {
       var dest = 'lib/' + (opts.output || opts.entry)
@@ -34,8 +40,10 @@ build({
 var plugins = [
   { name: 'search', entry: 'search/index.js', moduleName: 'Search' },
   { name: 'ga', entry: 'ga.js', moduleName: 'GA' },
-  { name: 'emoji', entry: 'emoji.js', moduleName: 'Emoji' }
-  // { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' }
+  { name: 'emoji', entry: 'emoji.js', moduleName: 'Emoji' },
+  { name: 'external-script', entry: 'external-script.js', moduleName: 'ExternalScript' },
+  { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' },
+  { name: 'zoom-image', entry: 'zoom-image.js', moduleName: 'ZoomImage' }
 ]
 
 plugins.forEach(item => {

docs/_coverpage.md

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

docs/_sidebar.md

@@ -10,7 +10,7 @@
   - [List of Plugins](/plugins)
   - [Write a Plugin](/write-a-plugin)
   - [Markdown configuration](/markdown)
-  - [Lanuage highlighting](/language-highlight)
+  - [Language highlighting](/language-highlight)
 
 - Guide
  - [Deploy](/deploy)

docs/configuration.md

@@ -173,7 +173,7 @@ window.$docsify = {
 - Type: `Boolean|String`
 - Default: `false`
 
-Activate the [cover feature](/cover). If ture, it will load from `_coverpage.md`.
+Activate the [cover feature](/cover). If true, it will load from `_coverpage.md`.
 
 ```js
 window.$docsify = {
@@ -306,3 +306,4 @@ window.$docsify = {
 
 ```
 
+Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins?id=external-script) plugin.

docs/custom-navbar.md

@@ -61,7 +61,7 @@ You can create sub-lists by indenting items that are under a certain parent.
   - [Themes](/themes)
   - [Using plugins](/plugins)
   - [Markdown configuration](/markdown)
-  - [Lanuage highlight](/language-highlight)
+  - [Language highlight](/language-highlight)
 ```
 
 renders as

docs/more-pages.md

@@ -5,12 +5,13 @@ If you need more pages, you can simply create more markdown files in your docsif
 For example, the directory structure is as follows:
 
 ```text
--| docs/
-  -| README.md
-  -| guide.md
-  -| zh-cn/
-    -| README.md
-    -| guide.md
+.
+├── docs
+|   └── README.md
+|   └── guide.md
+|   └── zh-cn
+|       └──README.md
+|       └──guide.md
 ```
 
 Matching routes
@@ -67,4 +68,4 @@ A custom sidebar can also automatically generate a table of contents by setting
   }
 </script>
 <script src="//unpkg.com/docsify"></script>
-```
+```

docs/plugins.md

@@ -75,3 +75,18 @@ The default is to support parsing emoji. For example `:100:` will be parsed to :
 <script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
 ```
 
+## External Script
+
+If the script on the page is an external one (imports a js file via `src` attribute), you'll need this plugin to make it work.
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/external-script.js"></script>
+```
+
+## Zoom image
+
+Medium's Image Zoom. Based on [zoom-image](https://github.com/egoist/zoom-image).
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
+```

docs/zh-cn/configuration.md

@@ -304,3 +304,4 @@ window.$docsify = {
 
 ```
 
+注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 [external-script](zh-cn/plugins?id=外链脚本-external-script) 插件。

docs/zh-cn/plugins.md

@@ -71,3 +71,19 @@
 ```html
 <script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
 ```
+
+## 外链脚本 - External Script
+
+如果文档里的 script 是内联脚本，可以直接执行；而如果是外链脚本（即 js 文件内容由 `src` 属性引入），则需要使用此插件。
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/external-script.js"></script>
+```
+
+## 图片缩放 - Zoom image
+
+Medium's 风格的图片缩放插件. 基于 [zoom-image](https://github.com/egoist/zoom-image)。
+
+```html
+<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
+```

lib/docsify.js

@@ -161,7 +161,7 @@ function getNode (el, noCache) {
   if ( noCache === void 0 ) noCache = false;
 
   if (typeof el === 'string') {
-    el = noCache ? find(el) : (cacheNode[el] || find(el));
+    el = noCache ? find(el) : (cacheNode[el] || (cacheNode[el] = find(el)));
   }
 
   return el

lib/plugins/external-script.js

@@ -0,0 +1,25 @@
+this.D = this.D || {};
+(function () {
+'use strict';
+
+function handleExternalScript () {
+  var container = Docsify.dom.getNode('#main');
+  var script = Docsify.dom.find(container, 'script');
+
+  if (script && script.src) {
+    var newScript = document.createElement('script');['src', 'async', 'defer'].forEach(function (attribute) {
+      newScript[attribute] = script[attribute];
+    });
+
+    script.parentNode.removeChild(script);
+    container.appendChild(newScript);
+  }
+}
+
+var install = function (hook) {
+  hook.doneEach(handleExternalScript);
+};
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+
+}());

lib/plugins/external-script.min.js

@@ -0,0 +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 c=document.createElement("script");["src","async","defer"].forEach(function(i){c[i]=n[i]}),n.parentNode.removeChild(n),i.appendChild(c)}}var n=function(n){n.doneEach(i)};window.$docsify.plugins=[].concat(n,window.$docsify.plugins)}();

lib/plugins/front-matter.js

@@ -0,0 +1,503 @@
+this.D = this.D || {};
+(function () {
+'use strict';
+
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/yaml.js
+ */
+/* eslint-disable */
+/*
+YAML parser for Javascript
+Author: Diogo Costa
+This program is released under the MIT License as follows:
+Copyright (c) 2011 Diogo Costa (costa.h4evr@gmail.com)
+Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+*/
+
+/**
+ * @name YAML
+ * @namespace
+*/
+
+
+var errors = [];
+var reference_blocks = [];
+var processing_time = 0;
+var regex$1 =
+    {
+        "regLevel" : new RegExp("^([\\s\\-]+)"),
+        "invalidLine" : new RegExp("^\\-\\-\\-|^\\.\\.\\.|^\\s*#.*|^\\s*$"),
+        "dashesString" : new RegExp("^\\s*\\\"([^\\\"]*)\\\"\\s*$"),
+        "quotesString" : new RegExp("^\\s*\\\'([^\\\']*)\\\'\\s*$"),
+        "float" : new RegExp("^[+-]?[0-9]+\\.[0-9]+(e[+-]?[0-9]+(\\.[0-9]+)?)?$"),
+        "integer" : new RegExp("^[+-]?[0-9]+$"),
+        "array" : new RegExp("\\[\\s*(.*)\\s*\\]"),
+        "map" : new RegExp("\\{\\s*(.*)\\s*\\}"),
+        "key_value" : new RegExp("([a-z0-9_-][ a-z0-9_-]*):( .+)", "i"),
+        "single_key_value" : new RegExp("^([a-z0-9_-][ a-z0-9_-]*):( .+?)$", "i"),
+        "key" : new RegExp("([a-z0-9_-][ a-z0-9_-]+):( .+)?", "i"),
+        "item" : new RegExp("^-\\s+"),
+        "trim" : new RegExp("^\\s+|\\s+$"),
+        "comment" : new RegExp("([^\\\'\\\"#]+([\\\'\\\"][^\\\'\\\"]*[\\\'\\\"])*)*(#.*)?")
+    };
+
+  /**
+  * @class A block of lines of a given level.
+  * @param {int} lvl The block's level.
+  * @private
+  */
+function Block(lvl) {
+    return {
+        /* The block's parent */
+        parent: null,
+        /* Number of children */
+        length: 0,
+        /* Block's level */
+        level: lvl,
+        /* Lines of code to process */
+        lines: [],
+        /* Blocks with greater level */
+        children : [],
+        /* Add a block to the children collection */
+        addChild : function(obj) {
+            this.children.push(obj);
+            obj.parent = this;
+            ++this.length;
+        }
+    };
+}
+
+function parser$1(str) {
+    var regLevel = regex$1["regLevel"];
+    var invalidLine = regex$1["invalidLine"];
+    var lines = str.split("\n");
+    var m;
+    var level = 0, curLevel = 0;
+
+    var blocks = [];
+
+    var result = new Block(-1);
+    var currentBlock = new Block(0);
+    result.addChild(currentBlock);
+    var levels = [];
+    var line = "";
+
+    blocks.push(currentBlock);
+    levels.push(level);
+
+    for(var i = 0, len = lines.length; i < len; ++i) {
+        line = lines[i];
+
+        if(line.match(invalidLine)) {
+            continue;
+        }
+
+        if(m = regLevel.exec(line)) {
+            level = m[1].length;
+        } else
+            { level = 0; }
+
+        if(level > curLevel) {
+            var oldBlock = currentBlock;
+            currentBlock = new Block(level);
+            oldBlock.addChild(currentBlock);
+            blocks.push(currentBlock);
+            levels.push(level);
+        } else if(level < curLevel) {
+            var added = false;
+
+            var k = levels.length - 1;
+            for(; k >= 0; --k) {
+                if(levels[k] == level) {
+                    currentBlock = new Block(level);
+                    blocks.push(currentBlock);
+                    levels.push(level);
+                    if(blocks[k].parent!= null)
+                        { blocks[k].parent.addChild(currentBlock); }
+                    added = true;
+                    break;
+                }
+            }
+
+            if(!added) {
+                errors.push("Error: Invalid indentation at line " + i + ": " + line);
+                return;
+            }
+        }
+
+        currentBlock.lines.push(line.replace(regex$1["trim"], ""));
+        curLevel = level;
+    }
+
+    return result;
+}
+
+function processValue(val) {
+    val = val.replace(regex$1["trim"], "");
+    var m = null;
+
+    if(val == 'true') {
+        return true;
+    } else if(val == 'false') {
+        return false;
+    } else if(val == '.NaN') {
+        return Number.NaN;
+    } else if(val == 'null') {
+        return null;
+    } else if(val == '.inf') {
+        return Number.POSITIVE_INFINITY;
+    } else if(val == '-.inf') {
+        return Number.NEGATIVE_INFINITY;
+    } else if(m = val.match(regex$1["dashesString"])) {
+        return m[1];
+    } else if(m = val.match(regex$1["quotesString"])) {
+        return m[1];
+    } else if(m = val.match(regex$1["float"])) {
+        return parseFloat(m[0]);
+    } else if(m = val.match(regex$1["integer"])) {
+        return parseInt(m[0]);
+    } else if( !isNaN(m = Date.parse(val))) {
+        return new Date(m);
+    } else if(m = val.match(regex$1["single_key_value"])) {
+        var res = {};
+        res[m[1]] = processValue(m[2]);
+        return res;
+    } else if(m = val.match(regex$1["array"])){
+        var count = 0, c = ' ';
+        var res = [];
+        var content = "";
+        var str = false;
+        for(var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+            c = m[1][j];
+            if(c == '\'' || c == '"') {
+                if(str === false) {
+                    str = c;
+                    content += c;
+                    continue;
+                } else if((c == '\'' && str == '\'') || (c == '"' && str == '"')) {
+                    str = false;
+                    content += c;
+                    continue;
+                }
+            } else if(str === false && (c == '[' || c == '{')) {
+                ++count;
+            } else if(str === false && (c == ']' || c == '}')) {
+                --count;
+            } else if(str === false && count == 0 && c == ',') {
+                res.push(processValue(content));
+                content = "";
+                continue;
+            }
+
+            content += c;
+        }
+
+        if(content.length > 0)
+            { res.push(processValue(content)); }
+        return res;
+    } else if(m = val.match(regex$1["map"])){
+        var count = 0, c = ' ';
+        var res = [];
+        var content = "";
+        var str = false;
+        for(var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+            c = m[1][j];
+            if(c == '\'' || c == '"') {
+                if(str === false) {
+                    str = c;
+                    content += c;
+                    continue;
+                } else if((c == '\'' && str == '\'') || (c == '"' && str == '"')) {
+                    str = false;
+                    content += c;
+                    continue;
+                }
+            } else if(str === false && (c == '[' || c == '{')) {
+                ++count;
+            } else if(str === false && (c == ']' || c == '}')) {
+                --count;
+            } else if(str === false && count == 0 && c == ',') {
+                res.push(content);
+                content = "";
+                continue;
+            }
+
+            content += c;
+        }
+
+        if(content.length > 0)
+            { res.push(content); }
+
+        var newRes = {};
+        for(var j = 0, lenJ = res.length; j < lenJ; ++j) {
+            if(m = res[j].match(regex$1["key_value"])) {
+                newRes[m[1]] = processValue(m[2]);
+            }
+        }
+
+        return newRes;
+    } else
+        { return val; }
+}
+
+function processFoldedBlock(block) {
+    var lines = block.lines;
+    var children = block.children;
+    var str = lines.join(" ");
+    var chunks = [str];
+    for(var i = 0, len = children.length; i < len; ++i) {
+        chunks.push(processFoldedBlock(children[i]));
+    }
+    return chunks.join("\n");
+}
+
+function processLiteralBlock(block) {
+    var lines = block.lines;
+    var children = block.children;
+    var str = lines.join("\n");
+    for(var i = 0, len = children.length; i < len; ++i) {
+        str += processLiteralBlock(children[i]);
+    }
+    return str;
+}
+
+function processBlock(blocks) {
+    var m = null;
+    var res = {};
+    var lines = null;
+    var children = null;
+    var currentObj = null;
+
+    var level = -1;
+
+    var processedBlocks = [];
+
+    var isMap = true;
+
+    for(var j = 0, lenJ = blocks.length; j < lenJ; ++j) {
+
+        if(level != -1 && level != blocks[j].level)
+            { continue; }
+
+        processedBlocks.push(j);
+
+        level = blocks[j].level;
+        lines = blocks[j].lines;
+        children = blocks[j].children;
+        currentObj = null;
+
+        for(var i = 0, len = lines.length; i < len; ++i) {
+            var line = lines[i];
+
+            if(m = line.match(regex$1["key"])) {
+                var key = m[1];
+
+                if(key[0] == '-') {
+                    key = key.replace(regex$1["item"], "");
+                    if (isMap) {
+                        isMap = false;
+                        if (typeof(res.length) === "undefined") {
+                            res = [];
+                        }
+                    }
+                    if(currentObj != null) { res.push(currentObj); }
+                    currentObj = {};
+                    isMap = true;
+                }
+
+                if(typeof m[2] != "undefined") {
+                    var value = m[2].replace(regex$1["trim"], "");
+                    if(value[0] == '&') {
+                        var nb = processBlock(children);
+                        if(currentObj != null) { currentObj[key] = nb; }
+                        else { res[key] = nb; }
+                        reference_blocks[value.substr(1)] = nb;
+                    } else if(value[0] == '|') {
+                        if(currentObj != null) { currentObj[key] = processLiteralBlock(children.shift()); }
+                        else { res[key] = processLiteralBlock(children.shift()); }
+                    } else if(value[0] == '*') {
+                        var v = value.substr(1);
+                        var no = {};
+
+                        if(typeof reference_blocks[v] == "undefined") {
+                            errors.push("Reference '" + v + "' not found!");
+                        } else {
+                            for(var k in reference_blocks[v]) {
+                                no[k] = reference_blocks[v][k];
+                            }
+
+                            if(currentObj != null) { currentObj[key] = no; }
+                            else { res[key] = no; }
+                        }
+                    } else if(value[0] == '>') {
+                        if(currentObj != null) { currentObj[key] = processFoldedBlock(children.shift()); }
+                        else { res[key] = processFoldedBlock(children.shift()); }
+                    } else {
+                        if(currentObj != null) { currentObj[key] = processValue(value); }
+                        else { res[key] = processValue(value); }
+                    }
+                } else {
+                    if(currentObj != null) { currentObj[key] = processBlock(children); }
+                    else { res[key] = processBlock(children); }
+                }
+            } else if(line.match(/^-\s*$/)) {
+                if (isMap) {
+                    isMap = false;
+                    if (typeof(res.length) === "undefined") {
+                        res = [];
+                    }
+                }
+                if(currentObj != null) { res.push(currentObj); }
+                currentObj = {};
+                isMap = true;
+                continue;
+            } else if(m = line.match(/^-\s*(.*)/)) {
+                if(currentObj != null)
+                    { currentObj.push(processValue(m[1])); }
+                else {
+                    if (isMap) {
+                        isMap = false;
+                        if (typeof(res.length) === "undefined") {
+                            res = [];
+                        }
+                    }
+                    res.push(processValue(m[1]));
+                }
+                continue;
+            }
+        }
+
+        if(currentObj != null) {
+            if (isMap) {
+                isMap = false;
+                if (typeof(res.length) === "undefined") {
+                    res = [];
+                }
+            }
+            res.push(currentObj);
+        }
+    }
+
+    for(var j = processedBlocks.length - 1; j >= 0; --j) {
+        blocks.splice.call(blocks, processedBlocks[j], 1);
+    }
+
+    return res;
+}
+
+function semanticAnalysis(blocks) {
+    var res = processBlock(blocks.children);
+    return res;
+}
+
+function preProcess(src) {
+    var m;
+    var lines = src.split("\n");
+
+    var r = regex$1["comment"];
+
+    for(var i in lines) {
+        if(m = lines[i].match(r)) {
+/*                var cmt = "";
+            if(typeof m[3] != "undefined")
+                lines[i] = m[1];
+            else if(typeof m[3] != "undefined")
+                lines[i] = m[3];
+            else
+                lines[i] = "";
+                */
+            if(typeof m[3] !== "undefined") {
+                lines[i] = m[0].substr(0, m[0].length - m[3].length);
+            }
+        }
+    }
+
+    return lines.join("\n");
+}
+
+function load(str) {
+    errors = [];
+    reference_blocks = [];
+    processing_time = (new Date()).getTime();
+    var pre = preProcess(str);
+    var doc = parser$1(pre);
+    var res = semanticAnalysis(doc);
+    processing_time = (new Date()).getTime() - processing_time;
+
+    return res;
+}
+
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/front-matter.js
+ */
+/* eslint-disable */
+var optionalByteOrderMark = '\\ufeff?';
+var pattern = '^(' +
+  optionalByteOrderMark +
+  '(= yaml =|---)' +
+  '$([\\s\\S]*?)' +
+  '(?:\\2|\\.\\.\\.)' +
+  '$' +
+  '' +
+  '(?:\\n)?)';
+// NOTE: If this pattern uses the 'g' flag the `regex` variable definition will
+// need to be moved down into the functions that use it.
+var regex = new RegExp(pattern, 'm');
+
+function extractor (string) {
+  string = string || '';
+
+  var lines = string.split(/(\r?\n)/);
+  if (lines[0] && /= yaml =|---/.test(lines[0])) {
+    return parse(string)
+  } else {
+    return { attributes: {}, body: string }
+  }
+}
+
+function parse (string) {
+  var match = regex.exec(string);
+
+  if (!match) {
+    return {
+      attributes: {},
+      body: string
+    }
+  }
+
+  var yaml = match[match.length - 1].replace(/^\s+|\s+$/g, '');
+  var attributes = load(yaml) || {};
+  var body = string.replace(match[0], '');
+
+  return { attributes: attributes, body: body, frontmatter: yaml }
+}
+
+var install = function (hook, vm) {
+  hook.beforeEach(function (content) {
+    var ref = extractor(content);
+    var attributes = ref.attributes;
+    var body = ref.body;
+
+    Docsify.util.merge(vm.config, attributes.config);
+
+    return body
+  });
+};
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+
+}());

lib/plugins/zoom-image.js

@@ -0,0 +1,304 @@
+this.D = this.D || {};
+(function () {
+'use strict';
+
+var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
+
+
+
+
+
+function createCommonjsModule(fn, module) {
+	return module = { exports: {} }, fn(module, module.exports), module.exports;
+}
+
+var zoomImage = createCommonjsModule(function (module, exports) {
+(function (global, factory) {
+  module.exports = factory();
+}(commonjsGlobal, (function () { 'use strict';
+
+var windowWidth = function () { return document.documentElement.clientWidth; };
+var windowHeight = function () { return document.documentElement.clientHeight; };
+
+var elemOffset = function (elem) {
+  var rect = elem.getBoundingClientRect();
+  var docElem = document.documentElement;
+  var win = window;
+  return {
+    top: rect.top + win.pageYOffset - docElem.clientTop,
+    left: rect.left + win.pageXOffset - docElem.clientLeft
+  }
+};
+
+var once = function (elem, type, handler) {
+  var fn = function (e) {
+    e.target.removeEventListener(type, fn);
+    handler();
+  };
+  elem.addEventListener(type, fn);
+};
+
+var Size = function Size(w, h) {
+  this.w = w;
+  this.h = h;
+};
+
+var ZoomImage = function ZoomImage(img, offset) {
+  this.img = img;
+  this.preservedTransform = img.style.transform;
+  this.wrap = null;
+  this.overlay = null;
+  this.offset = offset;
+};
+
+ZoomImage.prototype.forceRepaint = function forceRepaint () {
+  var _ = this.img.offsetWidth;
+  return
+};
+
+ZoomImage.prototype.zoom = function zoom () {
+  var size = new Size(this.img.naturalWidth, this.img.naturalHeight);
+
+  this.wrap = document.createElement('div');
+  this.wrap.classList.add('zoom-img-wrap');
+  this.img.parentNode.insertBefore(this.wrap, this.img);
+  this.wrap.appendChild(this.img);
+
+  this.img.classList.add('zoom-img');
+  this.img.setAttribute('data-action', 'zoom-out');
+
+  this.overlay = document.createElement('div');
+  this.overlay.classList.add('zoom-overlay');
+  document.body.appendChild(this.overlay);
+
+  this.forceRepaint();
+  var scale = this.calculateScale(size);
+
+  this.forceRepaint();
+  this.animate(scale);
+
+  document.body.classList.add('zoom-overlay-open');
+};
+
+ZoomImage.prototype.calculateScale = function calculateScale (size) {
+  var maxScaleFactor = size.w / this.img.width;
+
+  var viewportWidth = (windowWidth() - this.offset);
+  var viewportHeight = (windowHeight() - this.offset);
+  var imageAspectRatio = size.w / size.h;
+  var viewportAspectRatio = viewportWidth / viewportHeight;
+
+  if (size.w < viewportWidth && size.h < viewportHeight) {
+    return maxScaleFactor
+  } else if (imageAspectRatio < viewportAspectRatio) {
+    return (viewportHeight / size.h) * maxScaleFactor
+  }
+  return (viewportWidth / size.w) * maxScaleFactor
+};
+
+ZoomImage.prototype.animate = function animate (scale) {
+  var imageOffset = elemOffset(this.img);
+  var scrollTop = window.pageYOffset;
+
+  var viewportX = (windowWidth() / 2);
+  var viewportY = scrollTop + (windowHeight() / 2);
+
+  var imageCenterX = imageOffset.left + (this.img.width / 2);
+  var imageCenterY = imageOffset.top + (this.img.height / 2);
+
+  var tx = viewportX - imageCenterX;
+  var ty = viewportY - imageCenterY;
+  var tz = 0;
+
+  var imgTr = "scale(" + scale + ")";
+  var wrapTr = "translate3d(" + tx + "px, " + ty + "px, " + tz + "px)";
+
+  this.img.style.transform = imgTr;
+  this.wrap.style.transform = wrapTr;
+};
+
+ZoomImage.prototype.dispose = function dispose () {
+  if (this.wrap === null || this.wrap.parentNode === null) {
+    return
+  }
+  this.img.classList.remove('zoom-img');
+  this.img.setAttribute('data-action', 'zoom');
+
+  this.wrap.parentNode.insertBefore(this.img, this.wrap);
+  this.wrap.parentNode.removeChild(this.wrap);
+
+  document.body.removeChild(this.overlay);
+  document.body.classList.remove('zoom-overlay-transitioning');
+};
+
+ZoomImage.prototype.close = function close () {
+    var this$1 = this;
+
+  document.body.classList.add('zoom-overlay-transitioning');
+  this.img.style.transform = this.preservedTransform;
+  if (this.img.style.length === 0) {
+    this.img.removeAttribute('style');
+  }
+  this.wrap.style.transform = 'none';
+
+  once(this.img, 'transitionend', function () {
+    this$1.dispose();
+    // remove class should happen after dispose. Otherwise,
+    // a new click event could fire and create a duplicate ZoomImage for
+    // the same <img> element.
+    document.body.classList.remove('zoom-overlay-open');
+  });
+};
+
+/**
+ * Pure JavaScript implementation of zoom.js.
+ *
+ * Original preamble:
+ * zoom.js - It's the best way to zoom an image
+ * @version v0.0.2
+ * @link https://github.com/fat/zoom.js
+ * @license MIT
+ *
+ * Needs a related CSS file to work. See the README at
+ * https://github.com/nishanths/zoom.js for more info.
+ *
+ * This is a fork of the original zoom.js implementation by @fat.
+ * Copyrights for the original project are held by @fat. All other copyright
+ * for changes in the fork are held by Nishanth Shanmugham.
+ *
+ * Copyright (c) 2013 @fat
+ * The MIT License. Copyright © 2016 Nishanth Shanmugham.
+ */
+
+var current = null;
+var offset = 80;
+var initialScrollPos = -1;
+var initialTouchPos = -1;
+
+function handleScroll() {
+  if (initialScrollPos === -1) {
+    initialScrollPos = window.pageYOffset;
+  }
+
+  var deltaY = Math.abs(initialScrollPos - window.pageYOffset);
+  if (deltaY >= 40) {
+    closeCurrent();
+  }
+}
+
+function handleKeyup(e) {
+  if (e.keyCode === 27) {
+    closeCurrent();
+  }
+}
+
+function handleTouchStart(e) {
+  var t = e.touches[0];
+  if (t === null) {
+    return
+  }
+
+  initialTouchPos = t.pageY;
+  e.target.addEventListener('touchmove', handleTouchMove);
+}
+
+function handleTouchMove(e) {
+  var t = e.touches[0];
+  if (t === null) {
+    return
+  }
+
+  if (Math.abs(t.pageY - initialTouchPos) > 10) {
+    closeCurrent();
+    e.target.removeEventListener('touchmove', handleTouchMove);
+  }
+}
+
+function handleClick() {
+  closeCurrent();
+}
+
+function addCloseListeners() {
+  document.addEventListener('scroll', handleScroll);
+  document.addEventListener('keyup', handleKeyup);
+  document.addEventListener('touchstart', handleTouchStart);
+  document.addEventListener('click', handleClick, true);
+}
+
+function removeCloseListeners() {
+  document.removeEventListener('scroll', handleScroll);
+  document.removeEventListener('keyup', handleKeyup);
+  document.removeEventListener('touchstart', handleTouchStart);
+  document.removeEventListener('click', handleClick, true);
+}
+
+function closeCurrent(force) {
+  if (current === null) {
+    return
+  }
+  if (force) {
+    current.dispose();
+  } else {
+    current.close();
+  }
+  removeCloseListeners();
+  current = null;
+}
+
+function prepareZoom(e) {
+  if (document.body.classList.contains('zoom-overlay-open')) {
+    return
+  }
+
+  if (e.metaKey || e.ctrlKey) {
+    window.open((e.target.getAttribute('data-original') || e.target.src), '_blank');
+    return
+  }
+
+  if (e.target.width >= windowWidth() - offset) {
+    return
+  }
+
+  closeCurrent(true);
+
+  current = new ZoomImage(e.target, offset);
+  current.zoom();
+
+  addCloseListeners();
+}
+
+var zoom = function (el) {
+  el.setAttribute('data-action', 'zoom');
+  el.addEventListener('click', prepareZoom);
+  return function () { return el.removeEventListener('click', prepareZoom); }
+};
+
+return zoom;
+
+})));
+});
+
+var style = "img[data-action=\"zoom\"] {\n  cursor: pointer;\n  cursor: -webkit-zoom-in;\n  cursor: zoom-in;\n}\n.zoom-img,\n.zoom-img-wrap {\n  position: relative;\n  z-index: 666;\n  transition: -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1), -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n}\n.zoom-overlay {\n  z-index: 420;\n  background: #fff;\n  position: fixed;\n  top: 0;\n  left: 0;\n  right: 0;\n  bottom: 0;\n  pointer-events: none;\n  opacity: 0;\n  transition: opacity 300ms;\n}\n.zoom-overlay-open .zoom-overlay {\n  opacity: 1;\n}\n.zoom-overlay-open {\n  cursor: pointer;\n  cursor: -webkit-zoom-out;\n  cursor: zoom-out;\n}\n.zoom-overlay-transitioning {\n  cursor: default;\n}\n.zoom-overlay-open.zoom-overlay-transitioning .zoom-overlay{\n  opacity: 0;\n}\n";
+
+function install (hook) {
+  var dom = Docsify.dom;
+  var destroys;
+
+  // add style
+  dom.appendTo(dom.head, dom.create('style', style));
+
+  hook.doneEach(function (_) {
+    var images = dom.findAll('img:not(.emoji)');
+
+    if (Array.isArray(destroys) && destroys.length) {
+      destroys.forEach(function (o) { return o(); });
+      destroys = [];
+    }
+
+    destroys = images.map(zoomImage);
+  });
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins);
+
+}());

lib/plugins/zoom-image.min.js

@@ -0,0 +1 @@
+this.D=this.D||{},function(){"use strict";function t(t,e){return e={exports:{}},t(e,e.exports),e.exports}function e(t){var e,n=Docsify.dom;n.appendTo(n.head,n.create("style",i)),t.doneEach(function(t){var i=n.findAll("img:not(.emoji)");Array.isArray(e)&&e.length&&(e.forEach(function(t){return t()}),e=[]),e=i.map(o)})}var n="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},o=t(function(t,e){!function(e,n){t.exports=n()}(n,function(){function t(){g===-1&&(g=window.pageYOffset);var t=Math.abs(g-window.pageYOffset);t>=40&&a()}function e(t){27===t.keyCode&&a()}function n(t){var e=t.touches[0];null!==e&&(y=e.pageY,t.target.addEventListener("touchmove",o))}function o(t){var e=t.touches[0];null!==e&&Math.abs(e.pageY-y)>10&&(a(),t.target.removeEventListener("touchmove",o))}function i(){a()}function r(){document.addEventListener("scroll",t),document.addEventListener("keyup",e),document.addEventListener("touchstart",n),document.addEventListener("click",i,!0)}function s(){document.removeEventListener("scroll",t),document.removeEventListener("keyup",e),document.removeEventListener("touchstart",n),document.removeEventListener("click",i,!0)}function a(t){null!==h&&(t?h.dispose():h.close(),s(),h=null)}function c(t){if(!document.body.classList.contains("zoom-overlay-open"))return t.metaKey||t.ctrlKey?void window.open(t.target.getAttribute("data-original")||t.target.src,"_blank"):void(t.target.width>=m()-v||(a(!0),h=new p(t.target,v),h.zoom(),r()))}var m=function(){return document.documentElement.clientWidth},u=function(){return document.documentElement.clientHeight},d=function(t){var e=t.getBoundingClientRect(),n=document.documentElement,o=window;return{top:e.top+o.pageYOffset-n.clientTop,left:e.left+o.pageXOffset-n.clientLeft}},l=function(t,e,n){var o=function(t){t.target.removeEventListener(e,o),n()};t.addEventListener(e,o)},f=function(t,e){this.w=t,this.h=e},p=function(t,e){this.img=t,this.preservedTransform=t.style.transform,this.wrap=null,this.overlay=null,this.offset=e};p.prototype.forceRepaint=function(){this.img.offsetWidth},p.prototype.zoom=function(){var t=new f(this.img.naturalWidth,this.img.naturalHeight);this.wrap=document.createElement("div"),this.wrap.classList.add("zoom-img-wrap"),this.img.parentNode.insertBefore(this.wrap,this.img),this.wrap.appendChild(this.img),this.img.classList.add("zoom-img"),this.img.setAttribute("data-action","zoom-out"),this.overlay=document.createElement("div"),this.overlay.classList.add("zoom-overlay"),document.body.appendChild(this.overlay),this.forceRepaint();var e=this.calculateScale(t);this.forceRepaint(),this.animate(e),document.body.classList.add("zoom-overlay-open")},p.prototype.calculateScale=function(t){var e=t.w/this.img.width,n=m()-this.offset,o=u()-this.offset,i=t.w/t.h,r=n/o;return t.w<n&&t.h<o?e:i<r?o/t.h*e:n/t.w*e},p.prototype.animate=function(t){var e=d(this.img),n=window.pageYOffset,o=m()/2,i=n+u()/2,r=e.left+this.img.width/2,s=e.top+this.img.height/2,a=o-r,c=i-s,l=0,f="scale("+t+")",p="translate3d("+a+"px, "+c+"px, "+l+"px)";this.img.style.transform=f,this.wrap.style.transform=p},p.prototype.dispose=function(){null!==this.wrap&&null!==this.wrap.parentNode&&(this.img.classList.remove("zoom-img"),this.img.setAttribute("data-action","zoom"),this.wrap.parentNode.insertBefore(this.img,this.wrap),this.wrap.parentNode.removeChild(this.wrap),document.body.removeChild(this.overlay),document.body.classList.remove("zoom-overlay-transitioning"))},p.prototype.close=function(){var t=this;document.body.classList.add("zoom-overlay-transitioning"),this.img.style.transform=this.preservedTransform,0===this.img.style.length&&this.img.removeAttribute("style"),this.wrap.style.transform="none",l(this.img,"transitionend",function(){t.dispose(),document.body.classList.remove("zoom-overlay-open")})};var h=null,v=80,g=-1,y=-1,w=function(t){return t.setAttribute("data-action","zoom"),t.addEventListener("click",c),function(){return t.removeEventListener("click",c)}};return w})}),i='img[data-action="zoom"] {\n  cursor: pointer;\n  cursor: -webkit-zoom-in;\n  cursor: zoom-in;\n}\n.zoom-img,\n.zoom-img-wrap {\n  position: relative;\n  z-index: 666;\n  transition: -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1);\n  transition: transform 300ms cubic-bezier(.2,0,.2,1), -webkit-transform 300ms cubic-bezier(.2,0,.2,1);\n}\n.zoom-overlay {\n  z-index: 420;\n  background: #fff;\n  position: fixed;\n  top: 0;\n  left: 0;\n  right: 0;\n  bottom: 0;\n  pointer-events: none;\n  opacity: 0;\n  transition: opacity 300ms;\n}\n.zoom-overlay-open .zoom-overlay {\n  opacity: 1;\n}\n.zoom-overlay-open {\n  cursor: pointer;\n  cursor: -webkit-zoom-out;\n  cursor: zoom-out;\n}\n.zoom-overlay-transitioning {\n  cursor: default;\n}\n.zoom-overlay-open.zoom-overlay-transitioning .zoom-overlay{\n  opacity: 0;\n}\n';$docsify.plugins=[].concat(e,$docsify.plugins)}();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "A magical documentation generator.",
   "main": "lib/docsify.js",
   "files": [
@@ -40,11 +40,13 @@
     "rollup-plugin-buble": "^0.15.0",
     "rollup-plugin-commonjs": "^7.0.0",
     "rollup-plugin-node-resolve": "^2.0.0",
+    "rollup-plugin-string": "^2.0.2",
     "rollup-plugin-uglify": "^1.0.1",
     "serve-static": "^1.11.1"
   },
   "dependencies": {
     "marked": "^0.3.6",
-    "prismjs": "^1.5.1"
+    "prismjs": "^1.5.1",
+    "zoom-image": "^0.1.4"
   }
 }

src/core/util/dom.js

@@ -10,7 +10,7 @@ const cacheNode = {}
  */
 export function getNode (el, noCache = false) {
   if (typeof el === 'string') {
-    el = noCache ? find(el) : (cacheNode[el] || find(el))
+    el = noCache ? find(el) : (cacheNode[el] || (cacheNode[el] = find(el)))
   }
 
   return el

src/plugins/external-script.js

@@ -0,0 +1,21 @@
+function handleExternalScript () {
+  const container = Docsify.dom.getNode('#main')
+  const script = Docsify.dom.find(container, 'script')
+
+  if (script && script.src) {
+    const newScript = document.createElement('script')
+
+    ;['src', 'async', 'defer'].forEach(attribute => {
+      newScript[attribute] = script[attribute]
+    })
+
+    script.parentNode.removeChild(script)
+    container.appendChild(newScript)
+  }
+}
+
+const install = function (hook) {
+  hook.doneEach(handleExternalScript)
+}
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins)

src/plugins/zoom-image.js

@@ -0,0 +1,23 @@
+import zoom from 'zoom-image'
+import style from 'zoom-image/css/zoom-image.css'
+
+function install (hook) {
+  const dom = Docsify.dom
+  let destroys
+
+  // add style
+  dom.appendTo(dom.head, dom.create('style', style))
+
+  hook.doneEach(_ => {
+    const images = dom.findAll('img:not(.emoji)')
+
+    if (Array.isArray(destroys) && destroys.length) {
+      destroys.forEach(o => o())
+      destroys = []
+    }
+
+    destroys = images.map(zoom)
+  })
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)

src/themes/basic/_layout.css

@@ -10,7 +10,7 @@
 body:not(.ready) {
   overflow: hidden;
 
-  [data-cloak] {
+  [data-cloak], nav {
     display: none;
   }
 }