[release] 4.1.12

[build] 4.1.12
add changelog
2026-08-09 21:36:10 +10:00 · 2017-06-03 20:12:32 +08:00 · 2017-06-03 20:12:32 +08:00 · 2017-06-03 20:12:08 +08:00 · 2017-06-03 20:11:34 +08:00 · 2017-06-02 22:37:27 +08:00
29 changed files with 6154 additions and 92 deletions
@@ -1,9 +1,28 @@
 # Changelog

+4.1.12 / 2017-06-03
+
+  * fix(render): ubtitle in side bar shows undefined, fixed [#182](https://github.com/QingWei-Li/docsify/issues/182)
+
+4.1.11 / 2017-06-02
+
+  * fix(render): autoHeader does not work
+  * fix(compiler): force reset toc when rendering sidebar fixed [#181](https://github.com/QingWei-Li/docsify/issues/181)
+
+4.1.10 / 2017-06-02
+
+  * fix(hash): hash routing crashes when url has querystring
+
+4.1.9 / 2017-05-31
+
+  * fix(lifecycle): continue to handle data
+  * fix: can't render toc on first load, fixed [#171](https://github.com/QingWei-Li/docsify/issues/171)
+  * fix(render): broken name link, fixed [#167](https://github.com/QingWei-Li/docsify/issues/167)
+
 ## 4.1.8(since 4.1.1) / 2017-05-31

-  * fix(pure-css):add coverpage style, fixed #165
-  * feat: add edit button demo, close #162
+  * fix(pure-css):add coverpage style, fixed [#165](https://github.com/QingWei-Li/docsify/issues/165)
+  * feat: add edit button demo, close [#162](https://github.com/QingWei-Li/docsify/issues/162)
  * fix some ssr bugs

 ## 4.1.0 / 2017-05-30 🎂 to me
@@ -12,6 +12,7 @@
  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/QingWei-Li/docsify/master.svg?style=flat-square"></a>
  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
  <a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
+  <a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=shield"/></a>
 </p>

 ## Links
@@ -22,7 +23,7 @@
 ## Features

 - No statically built html files
- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - Smart full-text search plugin
 - Multiple themes
 - Useful plugin API
@@ -40,12 +41,12 @@ Create an `index.html`.
 <html>
 <head>
  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
 </head>
 <body>
  <div id="app"></div>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
 </body>
-<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
 </html>
 ```

@@ -55,7 +56,7 @@ Modern browsers and Internet Explorer 10+.

 ## Showcase

-These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
+These projects are using docsify to generate their sites. Pull requests welcome :blush:

 | Project | Description |
 |---|---|
@@ -95,3 +96,5 @@ open http://localhost:3000
 ## License

 MIT
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large)
@@ -30,7 +30,7 @@
    loadSidebar: true,
    coverpage: true,
    name: 'docsify',
-    subMaxLevel: 2,
+    subMaxLevel: 0,
    mergeNavbar: true,
    formatUpdated: '{MM}/{DD} {HH}:{mm}',
    routerMode: 'history',
@@ -11,12 +11,13 @@ See the [Quick start](quickstart.md) for more details.
 ## Features

 * No statically built html files
-* Simple and lightweight (~16kB gzipped)
+* Simple and lightweight (~18kB gzipped)
 * Smart full-text search plugin
 * Multiple themes
 * Useful plugin API
 * Emoji support
 * Compatible with IE10+
+- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))

 ## Examples

@@ -1,10 +1,10 @@
 ![logo](_media/icon.svg)

-# docsify <small>4.1.8</small>
+# docsify <small>4.1.12</small>

 > A magical documentation site generator.

- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - No statically built html files
 - Multiple themes

@@ -45,6 +45,6 @@ Alternatively, use [compressed files](#compressed-files).
 ## Other CDN

 - http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
 - https://cdnjs.com/libraries/docsify

@@ -26,7 +26,7 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:

 > A magical documentation site generator.

- Simple and lightweight (~16kB gzipped)
+- Simple and lightweight (~18kB gzipped)
 - No statically built html files
 - Multiple themes

@@ -11,12 +11,13 @@ Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen.
 ## Features

 * keine generierten, statischen HTML Dateien
-* einfach und klein (~16kB gzipped)
+* einfach und klein (~18kB gzipped)
 * smarte Erweiterung mit Volltextsuche
 * mehrere Themes
 * praktische API für Erweiterungen
 * Unterstützung für Emoji
 * Kompatibel mit IE10+
+- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))

 ## Beispiele

@@ -45,5 +45,5 @@ Alternativ kannst du auch die [komprimierten Dateien](#komprimierte-dateien) ver
 ## Andere CDN

 - http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
 - https://cdnjs.com/libraries/docsify
@@ -26,7 +26,7 @@ Setze `coverpage` auf **true**, und erstelle `_coverpage.md`:

 > Ein magischer Generator für Dokumentationsseiten.

- Einfach und wenig Speicherbedarf (~16kB gzipped)
+- Einfach und wenig Speicherbedarf (~18kB gzipped)
 - Keine statischen HTML Dateien
 - Mehrere Themes

@@ -7,10 +7,10 @@
  <meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
  <meta name="description" content="A magical documentation generator.">
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" title="dark" disabled>
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="buble" disabled>
-  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css" title="pure" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/vue.css" title="vue">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/dark.css" title="dark" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/buble.css" title="buble" disabled>
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@latest/lib/themes/pure.css" title="pure" disabled>
  <style>
    nav.app-nav li ul {
      min-width: 100px;
@@ -66,9 +66,9 @@
    ]
  }
 </script>
-<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
-<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
-<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
-<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
-<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify@latest/lib/docsify.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify@latest/lib/plugins/search.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-markdown.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-nginx.min.js"></script>
 </html>
@@ -12,12 +12,13 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo

 ## 特性
 - 无需构建，写完文档直接发布
- 容易使用并且轻量 (~16kB gzipped)
+- 容易使用并且轻量 (~18kB gzipped)
 - 智能的全文搜索
 - 提供多套主题
 - 丰富的 API
 - 支持 Emoji
 - 兼容 IE10+
+- 支持 SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))

 ## 例子

@@ -44,6 +44,6 @@ JS 的压缩文件是原有文件路径的基础上加 `.min`后缀

 ## 其他 CDN

- http://www.bootcdn.cn/docsify
- http://www.jsdelivr.com/projects/docsify
+- http://www.bootcdn.cn/docsify (支持国内)
+- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
 - https://cdnjs.com/libraries/docsify
@@ -8,4 +8,4 @@
 <script src="//unpkg.com/prismjs/components/prism-php.js"></script>
 ```

-?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)。
+?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)。
@@ -0,0 +1,7 @@
+{
+  "lerna": "2.0.0-rc.5",
+  "packages": [
+    "packages/*"
+  ],
+  "version": "0.0.0"
+}
@@ -126,23 +126,22 @@ function initLifecycle (vm) {
 function callHook (vm, hook, data, next) {
  if ( next === void 0 ) next = noop;

-  var newData = data;
  var queue = vm._hooks[hook];

  var step = function (index) {
    var hook = queue[index];
    if (index >= queue.length) {
-      next(newData);
+      next(data);
    } else {
      if (typeof hook === 'function') {
        if (hook.length === 2) {
          hook(data, function (result) {
-            newData = result;
+            data = result;
            step(index + 1);
          });
        } else {
          var result = hook(data);
-          newData = result !== undefined ? result : newData;
+          data = result !== undefined ? result : data;
          step(index + 1);
        }
      } else {
@@ -2797,8 +2796,8 @@ Compiler.prototype._initRenderer = function _initRenderer () {
  var ref = this;
    var linkTarget = ref.linkTarget;
    var router = ref.router;
-    var toc = ref.toc;
    var contentBase = ref.contentBase;
+  var _self = this;
  /**
   * render anchor tag
   * @link https://github.com/chjj/marked#overriding-renderer-methods
@@ -2821,7 +2820,7 @@ Compiler.prototype._initRenderer = function _initRenderer () {
    var slug = slugify(text);
    var url = router.toURL(router.getCurrentPath(), { id: slug });
    nextToc.slug = url;
-    toc.push(nextToc);
+    _self.toc.push(nextToc);

    return ("<h" + level + " id=\"" + slug + "\"><a href=\"" + url + "\" data-id=\"" + slug + "\" class=\"anchor\"><span>" + text + "</span></a></h" + level + ">")
  };
@@ -2890,6 +2889,10 @@ Compiler.prototype.sidebar = function sidebar (text, level) {
 * Compile sub sidebar
 */
 Compiler.prototype.subSidebar = function subSidebar (level) {
+  if (!level) {
+    this.toc = [];
+    return
+  }
  var currentPath = this.router.getCurrentPath();
  var ref = this;
    var cacheTree = ref.cacheTree;
@@ -3159,10 +3162,13 @@ function renderMixin (proto) {
    this._renderTo('.sidebar-nav', this.compiler.sidebar(text, maxLevel));
    var activeEl = getAndActive(this.router, '.sidebar-nav', true, true);
    if (loadSidebar && activeEl) {
-      activeEl.parentNode.innerHTML += this.compiler.subSidebar(subMaxLevel);
+      activeEl.parentNode.innerHTML += (this.compiler.subSidebar(subMaxLevel) || '');
+    } else {
+      // reset toc
+      this.compiler.subSidebar();
    }
    // bind event
-    this._bindEventOnRendered();
+    this._bindEventOnRendered(activeEl);
  };

  proto._bindEventOnRendered = function (activeEl) {
@@ -3288,6 +3294,7 @@ function initRender (vm) {
    // Polyfll
    cssVars(config.themeColor);
  }
+  vm._updateRender();
  toggleClass(body, 'ready');
 }

@@ -3403,17 +3410,17 @@ var HashHistory = (function (History$$1) {

    var query = '';

+    var hashIndex = path.indexOf('#');
+    if (hashIndex) {
+      path = path.slice(hashIndex + 1);
+    }
+
    var queryIndex = path.indexOf('?');
    if (queryIndex >= 0) {
      query = path.slice(queryIndex + 1);
      path = path.slice(0, queryIndex);
    }

-    var hashIndex = path.indexOf('#');
-    if (hashIndex) {
-      path = path.slice(hashIndex + 1);
-    }
-
    return {
      path: path,
      file: this.getFile(path),
@@ -3544,7 +3551,6 @@ function initRouter (vm) {

  router.normalize();
  lastRoute = vm.route = router.parse();
-  vm._updateRender();

  router.onchange(function (_) {
    router.normalize();
@@ -3744,7 +3750,7 @@ initGlobalAPI();
 /**
 * Version
 */
-Docsify.version = '4.1.8';
+Docsify.version = '4.1.12';

 /**
 * Run Docsify
@@ -498,6 +498,6 @@ var install = function (hook, vm) {
  });
 };

-window.$docsify.plugins = [].concat(install, window.$docsify.plugins);
+$docsify.plugins = [].concat(install, $docsify.plugins);

 }());
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "4.1.8",
+  "version": "4.1.12",
  "description": "A magical documentation generator.",
  "author": {
    "name": "qingwei-li",
@@ -20,6 +20,7 @@
    "themes"
  ],
  "scripts": {
+    "bootstrap": "npm i && lerna bootstrap",
    "build": "rm -rf lib themes && node build/build && mkdir lib/themes && mkdir themes && node build/build-css && npm run build:ssr && node build/build-cover",
    "dev:build": "rm -rf lib themes && mkdir themes && node build/build --dev && node build/build-css --dev",
    "dev": "node app & nodemon -w src -e js,css --exec 'npm run dev:build'",
@@ -39,6 +40,7 @@
    "eslint": "^3.18.0",
    "eslint-config-vue": "^2.0.2",
    "eslint-plugin-vue": "^2.0.1",
+    "lerna": "^2.0.0-rc.5",
    "nodemon": "^1.11.0",
    "postcss": "^5.2.16",
    "postcss-salad": "^1.0.8",
@@ -1,6 +1,6 @@
 {
  "name": "docsify-server-renderer",
-  "version": "4.1.8",
+  "version": "4.1.12",
  "description": "docsify server renderer",
  "author": {
    "name": "qingwei-li",
@@ -19,23 +19,22 @@ export function initLifecycle (vm) {
 }

 export function callHook (vm, hook, data, next = noop) {
-  let newData = data
  const queue = vm._hooks[hook]

  const step = function (index) {
    const hook = queue[index]
    if (index >= queue.length) {
-      next(newData)
+      next(data)
    } else {
      if (typeof hook === 'function') {
        if (hook.length === 2) {
          hook(data, result => {
-            newData = result
+            data = result
            step(index + 1)
          })
        } else {
          const result = hook(data)
-          newData = result !== undefined ? result : newData
+          data = result !== undefined ? result : data
          step(index + 1)
        }
      } else {
@@ -44,7 +44,8 @@ export class Compiler {

  _initRenderer () {
    const renderer = new marked.Renderer()
-    const { linkTarget, router, toc, contentBase } = this
+    const { linkTarget, router, contentBase } = this
+    const _self = this
    /**
     * render anchor tag
     * @link https://github.com/chjj/marked#overriding-renderer-methods
@@ -67,7 +68,7 @@ export class Compiler {
      const slug = slugify(text)
      const url = router.toURL(router.getCurrentPath(), { id: slug })
      nextToc.slug = url
-      toc.push(nextToc)
+      _self.toc.push(nextToc)

      return `<h${level} id="${slug}"><a href="${url}" data-id="${slug}" class="anchor"><span>${text}</span></a></h${level}>`
    }
@@ -134,6 +135,10 @@ export class Compiler {
   * Compile sub sidebar
   */
  subSidebar (level) {
+    if (!level) {
+      this.toc = []
+      return
+    }
    const currentPath = this.router.getCurrentPath()
    const { cacheTree, toc } = this

@@ -84,10 +84,13 @@ export function renderMixin (proto) {
    this._renderTo('.sidebar-nav', this.compiler.sidebar(text, maxLevel))
    const activeEl = getAndActive(this.router, '.sidebar-nav', true, true)
    if (loadSidebar && activeEl) {
-      activeEl.parentNode.innerHTML += this.compiler.subSidebar(subMaxLevel)
+      activeEl.parentNode.innerHTML += (this.compiler.subSidebar(subMaxLevel) || '')
+    } else {
+      // reset toc
+      this.compiler.subSidebar()
    }
    // bind event
-    this._bindEventOnRendered()
+    this._bindEventOnRendered(activeEl)
  }

  proto._bindEventOnRendered = function (activeEl) {
@@ -208,5 +211,6 @@ export function initRender (vm) {
    // Polyfll
    cssVars(config.themeColor)
  }
+  vm._updateRender()
  dom.toggleClass(dom.body, 'ready')
 }
@@ -58,17 +58,17 @@ export class HashHistory extends History {
  parse (path = location.href) {
    let query = ''

+    const hashIndex = path.indexOf('#')
+    if (hashIndex) {
+      path = path.slice(hashIndex + 1)
+    }
+
    const queryIndex = path.indexOf('?')
    if (queryIndex >= 0) {
      query = path.slice(queryIndex + 1)
      path = path.slice(0, queryIndex)
    }

-    const hashIndex = path.indexOf('#')
-    if (hashIndex) {
-      path = path.slice(hashIndex + 1)
-    }
-
    return {
      path,
      file: this.getFile(path),
@@ -23,7 +23,6 @@ export function initRouter (vm) {

  router.normalize()
  lastRoute = vm.route = router.parse()
-  vm._updateRender()

  router.onchange(_ => {
    router.normalize()
@@ -10,4 +10,4 @@ const install = function (hook, vm) {
  })
 }

-window.$docsify.plugins = [].concat(install, window.$docsify.plugins)
+$docsify.plugins = [].concat(install, $docsify.plugins)
Author	SHA1	Message	Date
qingwei.li	b37781e949	[release] 4.1.12	2017-06-03 20:12:32 +08:00
qingwei.li	54a48dd3ff	[build] 4.1.12	2017-06-03 20:12:32 +08:00
qingwei.li	1aabc41db7	add changelog	2017-06-03 20:12:08 +08:00
qingwei.li	d087d5753b	fix(render): ubtitle in side bar shows undefined, fixed #182	2017-06-03 20:11:34 +08:00
qingwei.li	bb793ec08e	update package size	2017-06-02 22:37:27 +08:00
qingwei.li	6a78ae7ddc	[release] 4.1.11	2017-06-02 22:18:36 +08:00
qingwei.li	ac28040bd7	[build] 4.1.11	2017-06-02 22:18:36 +08:00
qingwei.li	b12f74b159	add changelog	2017-06-02 22:16:39 +08:00
qingwei.li	1304d2ea1a	fix(render): autoHeader does not work	2017-06-02 22:14:28 +08:00
qingwei.li	ccf4c7c5cc	fix(compiler): force reset toc when rendering sidebar fixed #181	2017-06-02 22:12:07 +08:00
qingwei.li	9b15d8d577	update cdn version	2017-06-02 18:04:20 +08:00
qingwei.li	642e7da7ee	[release] 4.1.10	2017-06-02 17:57:56 +08:00
qingwei.li	75381cf046	[build] 4.1.10	2017-06-02 17:57:56 +08:00
qingwei.li	7e2e5a7c90	add changelog	2017-06-02 17:57:32 +08:00
qingwei.li	6d48ce1266	fix(hash): hash routing crashes when url has querystring	2017-06-02 17:56:38 +08:00
qingwei.li	d286963da0	update readme	2017-06-02 17:41:13 +08:00
qingwei.li	8a4cedd962	replaced unpkg cdn with jsdelivr	2017-06-01 21:25:08 +08:00
Wei Wangandcinwell.li	a3b7b66a76	Fix broken footer (#178 )	2017-06-01 13:32:39 +08:00
qingwei.li	5a0d4b7897	docs(cdn): update jsdelivr cdn	2017-06-01 10:29:12 +08:00
Michelle Brierandcinwell.li	fcfdb17b8d	Add license scan badge (#176 )	2017-06-01 07:44:19 +08:00
Michelle Brierandcinwell.li	e4d2e7ec12	Add license report Large report badge	2017-06-01 07:43:59 +08:00
qingwei.li	ece00e6b3a	[release] 4.1.9	2017-05-31 22:32:57 +08:00
qingwei.li	841829427b	[build] 4.1.9	2017-05-31 22:32:30 +08:00
qingwei.li	56c7b9ae2d	add changelog	2017-05-31 22:20:46 +08:00
qingwei.li	db8400a6ac	docs: add feature	2017-05-31 22:19:43 +08:00
qingwei.li	955d3d5988	fix(lifecycle): continue to handle data	2017-05-31 21:20:09 +08:00
qingwei.li	d9b487e67b	fix: can't render toc on first load	2017-05-31 20:42:29 +08:00
qingwei.li	91b66a5cac	fix(render): broken name link, fixed #167	2017-05-31 20:35:59 +08:00
qingwei.li	90bba60367	add package-lock.json	2017-05-31 14:22:43 +08:00
qingwei.li	d05c4f65a8	add lerna	2017-05-31 10:01:15 +08:00