-> v1.7.1

bump 1.7.1
Fix sidebar style in mobile browser
2026-08-09 21:36:10 +10:00 · 2017-01-12 20:46:24 +08:00 · 2017-01-12 20:46:04 +08:00 · 2017-01-12 20:45:35 +08:00 · 2017-01-12 20:34:47 +08:00 · 2017-01-12 20:30:13 +08:00
22 changed files with 3843 additions and 168 deletions
@@ -1,5 +1,4 @@
 .DS_Store
 *.log
 node_modules
-yarn.lock
 /themes
@@ -1,3 +1,29 @@
+## 1.7.1
+### Bug fixes
+- Fix sidebar style in mobile browser.
+
+## 1.7.0
+
+### Bug fixes
+- Fixed custom cover background, fixed #52
+- Fixed sticky sidebar
+
+## Features
+- Add `name` and `nameLink`
+
+## 1.6.1
+### Bug fixes
+- Fixed sidebar bug when the coverpage exist
+
+## 1.6.0
+### Features
+- Improve sidebar performance. The active item is automatically scrolled in the visible view.
+- New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
+
+## 1.5.2
+### Bug fixes
+- Fixed number at the beginning of the slug
+
 ## 1.5.1
 ### Bug fixes
 - Remove HTML tag when handling slug
@@ -52,6 +52,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
 - [docsify](https://docsify.js.org) - A magical documentation site generator.
 - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
 - [puck](https://puck.zz173.com/) - A small & magical php framework.
+- [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency.

 ## Similar projects
 - [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
@@ -69,7 +70,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
 ## Development

 ### prepare
-```shell
+```bash
 npm i && npm run dev
 open http://localhost:3000
 ```
@@ -8,5 +8,5 @@
 <body class="">
  <div id="app"></div>
 </body>
-<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-auto2top data-sidebar-toggle data-router></script>
+<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-name="docsify" data-auto2top data-sidebar-toggle data-router></script>
 </html>
@@ -2,7 +2,7 @@

 ### Create a project
 First create a project, then create a `docs` folder
-```shell
+```bash
 mkdir my-project && cd my-project
 mkdir docs && cd docs
 ```
@@ -26,7 +26,7 @@ Create a `index.html` file

 Create `README.md` as the main page

-```
+```markdown
 # Title

 ## blabla
@@ -41,20 +41,20 @@ Push code and activate **GitHub Pages** via your repo's settings
 Easy to setup and preview a docs.

 ### Install
-```shell
+```bash
 npm i docsify-cli -g
 ```

 ### Setup

 Setup a boilerplate docs
-```shell
+```bash
 docsify init docs
 ```

 ### Preview
 Preview and serve your docs using
-```shell
+```bash
 docsify serve docs
 ```

@@ -157,6 +157,26 @@ window.$docsify = {
 }
 ```

+### Doc Helpers
+#### p.tip
+
+'! ' add your content will rendered as `<p class="tip">content</p>`
+
+```markdown
+! Important **information**
+```
+
+It will be rendered
+
+```html
+<p class="tip">Important <strong>information</strong></p>
+```
+
+e.g.
+
+! Important **information**
+
+
 ## Options

 You can add configurations in the script tag attributes or with `window.$docsify`.
@@ -351,11 +371,14 @@ Scroll to the top on changing hash.

 ```html
 <script src="/lib/docsify.js" data-auto2top></script>
+<!-- Set offset top -->
+<script src="/lib/docsify.js" data-auto2top="50"></script>
 ```

 ```js
 window.$docsify = {
-  auto2top: true
+  auto2top: true,
+  // auto2top: 50
 }
 ```

@@ -410,4 +433,35 @@ Generate cover page.
 window.$docsify = {
  coverpage: true
 }
-```
+```
+
+### name
+
+Project name. It is displayed in the sidebar.
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### nameLink
+
+Name link. The default value is `window.location.pathname`.
+
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+
+
@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)

-# docsify <small>1.5.1</small>
+# docsify <small>1.7.1</small>

 > A magical documentation site generator.

@@ -20,5 +20,8 @@
  data-max-level="4"
  data-sidebar-toggle
  data-coverpage
+  data-name="docsify"
  data-router></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
 </html>
@@ -8,7 +8,7 @@

 ### 创建项目
 新建一个空项目，接着创建一个 `docs` 目录并进入到 docs 目录下
-```shell
+```bash
 mkdir my-project && cd my-project
 mkdir docs && cd docs
 ```
@@ -46,20 +46,20 @@ mkdir docs && cd docs
 方便快速创建文档目录，会读取项目的 `package.json` 里的选项作为 docsify 的配置，支持本地预览。

 ### 安装
-```shell
+```bash
 npm i docsify-cli -g
 ```

 ### 初始化文档

 默认初始化在当前目录，推荐将文档放在 `docs` 目录下
-```shell
+```bash
 docsify init docs
 ```

 ### 启动本地服务
 启动一个 server 方便预览，打开 http://localhost:3000
-```shell
+```bash
 docsify serve docs
 ```

@@ -163,6 +163,24 @@ window.$docsify = {
 }
 ```

+### 文档助手
+#### 内置「提示」语法
+
+感叹号加空格，后面接内容，会渲染成带 tip 类名的段落。
+
+```markdown
+! 提示信息，**支持其他 markdown 语法**
+```
+
+将被渲染成
+
+```html
+<p class="tip">提示信息<strong>支持其他 markdown 语法</strong></p>
+```
+
+效果
+
+! 适合显示醒目的内容

 ## 配置参数

@@ -419,3 +437,33 @@ window.$docsify = {
  coverpage: true
 }
 ```
+
+
+### name
+
+项目名，将显示在侧边栏。
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### nameLink
+
+项目名链接，默认为 `window.location.pathname`。
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+
@@ -127,7 +127,9 @@ function slugify (string) {
  var slug = string.trim()
    .replace(/<[^>\d]+>/g, '')
    .replace(re, '')
-    .replace(/\s/g, replacement);
+    .replace(/\s/g, replacement)
+    .replace(/-+/g, replacement)
+    .replace(/^(\d)/, '_$1');
  var occurrences = slugify.occurrences[slug];

  if (slugify.occurrences.hasOwnProperty(slug)) {
@@ -173,10 +175,12 @@ var merge = Object.assign || function (to) {
 function scrollActiveSidebar () {
  if (isMobile()) { return }

+  var hoveredOverSidebar = false;
  var anchors = document.querySelectorAll('.anchor');
+  var sidebar = document.querySelector('aside.sidebar');
  var nav = {};
-  var lis = document.querySelectorAll('.sidebar li');
-  var active = null;
+  var lis = sidebar.querySelectorAll('li');
+  var active = sidebar.querySelector('li.active');

  for (var i = 0, len = lis.length; i < len; i += 1) {
    var li = lis[i];
@@ -191,27 +195,34 @@ function scrollActiveSidebar () {
  }

  function highlight () {
+    var top = document.body.scrollTop;
+    var last;
+
    for (var i = 0, len = anchors.length; i < len; i += 1) {
      var node = anchors[i];
-      var bcr = node.getBoundingClientRect();

-      if (bcr.top < 10 && bcr.bottom > 10) {
-        var li = nav[node.getAttribute('data-id')];
-
-        if (!li || li === active) { return }
-        if (active) { active.setAttribute('class', ''); }
-
-        li.setAttribute('class', 'active');
-        active = li;
-
-        return
+      if (node.offsetTop > top) {
+        if (!last) { last = node; }
+        break
+      } else {
+        last = node;
      }
    }
+    if (!last) { return }
+    var li = nav[last.getAttribute('data-id')];
+
+    if (!li || li === active) { return }
+    if (active) { active.classList.remove('active'); }
+
+    li.classList.add('active');
+    active = li;
+    !hoveredOverSidebar && !sticky.noSticky && active.scrollIntoView(false);
  }

  window.removeEventListener('scroll', highlight);
  window.addEventListener('scroll', highlight);
-  highlight();
+  sidebar.addEventListener('mouseover', function () { hoveredOverSidebar = true; });
+  sidebar.addEventListener('mouseleave', function () { hoveredOverSidebar = false; });
 }

 function scrollIntoView () {
@@ -219,7 +230,9 @@ function scrollIntoView () {
  if (!id || !id.length) { return }
  var section = document.querySelector(decodeURIComponent(id[0]));

-  if (section) { section.scrollIntoView(); }
+  if (section) { setTimeout(function () { return section.scrollIntoView(); }, 0); }
+
+  return section
 }

 /**
@@ -235,13 +248,13 @@ function activeLink (dom, activeParent) {
    .forEach(function (node) {
      if (host.indexOf(node.href) === 0 && !target) {
        activeParent
-          ? node.parentNode.setAttribute('class', 'active')
-          : node.setAttribute('class', 'active');
+          ? node.parentNode.classList.add('active')
+          : node.classList.add('active');
        target = node;
      } else {
        activeParent
-          ? node.parentNode.removeAttribute('class')
-          : node.removeAttribute('class');
+          ? node.parentNode.classList.remove('active')
+          : node.classList.remove('active');
      }
    });

@@ -259,24 +272,31 @@ function bindToggle (dom) {
  dom.addEventListener('click', function () { return body.classList.toggle('close'); });

  if (isMobile()) {
-    document.querySelector('aside')
-      .addEventListener('click', function (_) { return body.classList.toggle('close'); });
+    var sidebar = document.querySelector('aside.sidebar');
+    document.body.addEventListener('click', function (e) {
+      if (e.target !== dom && !dom.contains(e.target)) { body.classList.toggle('close'); }
+      if (sidebar.contains(e.target)) { setTimeout(function () { return activeLink(sidebar, true); }, 0); }
+    });
  }
 }

-function scroll2Top () {
-  document.body.scrollTop = 0;
+function scroll2Top (offset) {
+  if ( offset === void 0 ) offset = 0;
+
+  document.body.scrollTop = offset === true ? 0 : Number(offset);
 }

 function sticky () {
-  var dom = document.querySelector('section.cover');
-  var coverHeight = dom.getBoundingClientRect().height;
+  sticky.dom = sticky.dom || document.querySelector('section.cover');
+  var coverHeight = sticky.dom.getBoundingClientRect().height;

  return (function () {
-    if (window.pageYOffset >= coverHeight || dom.classList.contains('hidden')) {
+    if (window.pageYOffset >= coverHeight || sticky.dom.classList.contains('hidden')) {
      document.body.classList.add('sticky');
+      sticky.noSticky = false;
    } else {
      document.body.classList.remove('sticky');
+      sticky.noSticky = true;
    }
  })()
 }
@@ -1579,12 +1599,8 @@ marked.inlineLexer = InlineLexer.output;

 marked.parse = marked;

-if (typeof module !== 'undefined' && typeof exports === 'object') {
+{
  module.exports = marked;
-} else if (typeof define === 'function' && define.amd) {
-  define(function() { return marked; });
-} else {
-  this.marked = marked;
 }

 }).call(function() {
@@ -1802,6 +1818,9 @@ var _ = _self.Prism = {
 		_.hooks.run('before-sanity-check', env);

 		if (!env.code || !env.grammar) {
+			if (env.code) {
+				env.element.textContent = env.code;
+			}
 			_.hooks.run('complete', env);
 			return;
 		}
@@ -1879,9 +1898,16 @@ var _ = _self.Prism = {
 					lookbehindLength = 0,
 					alias = pattern.alias;

+				if (greedy && !pattern.pattern.global) {
+					// Without the global flag, lastIndex won't work
+					var flags = pattern.pattern.toString().match(/[imuy]*$/)[0];
+					pattern.pattern = RegExp(pattern.pattern.source, flags + "g");
+				}
+
 				pattern = pattern.pattern || pattern;

-				for (var i=0; i<strarr.length; i++) { // Don’t cache length as it changes during the loop
+				// Don’t cache length as it changes during the loop
+				for (var i=0, pos = 0; i<strarr.length; pos += strarr[i].length, ++i) {

 					var str = strarr[i];

@@ -1901,40 +1927,38 @@ var _ = _self.Prism = {

 					// Greedy patterns can override/remove up to two previously matched tokens
 					if (!match && greedy && i != strarr.length - 1) {
-						// Reconstruct the original text using the next two tokens
-						var nextToken = strarr[i + 1].matchedStr || strarr[i + 1],
-						    combStr = str + nextToken;
-
-						if (i < strarr.length - 2) {
-							combStr += strarr[i + 2].matchedStr || strarr[i + 2];
-						}
-
-						// Try the pattern again on the reconstructed text
-						pattern.lastIndex = 0;
-						match = pattern.exec(combStr);
+						pattern.lastIndex = pos;
+						match = pattern.exec(text);
 						if (!match) {
-							continue;
+							break;
 						}

-						var from = match.index + (lookbehind ? match[1].length : 0);
-						// To be a valid candidate, the new match has to start inside of str
-						if (from >= str.length) {
+						var from = match.index + (lookbehind ? match[1].length : 0),
+						    to = match.index + match[0].length,
+						    k = i,
+						    p = pos;
+
+						for (var len = strarr.length; k < len && p < to; ++k) {
+							p += strarr[k].length;
+							// Move the index i to the element in strarr that is closest to from
+							if (from >= p) {
+								++i;
+								pos = p;
+							}
+						}
+
+						/*
+						 * If strarr[i] is a Token, then the match starts inside another Token, which is invalid
+						 * If strarr[k - 1] is greedy we are in conflict with another greedy pattern
+						 */
+						if (strarr[i] instanceof Token || strarr[k - 1].greedy) {
 							continue;
 						}
-						var to = match.index + match[0].length,
-						    len = str.length + nextToken.length;

 						// Number of tokens to delete and replace with the new match
-						delNum = 3;
-
-						if (to <= len) {
-							if (strarr[i + 1].greedy) {
-								continue;
-							}
-							delNum = 2;
-							combStr = combStr.slice(0, len);
-						}
-						str = combStr;
+						delNum = k - i;
+						str = text.slice(pos, p);
+						match.index -= pos;
 					}

 					if (!match) {
@@ -2003,7 +2027,7 @@ var Token = _.Token = function(type, content, alias, matchedStr, greedy) {
 	this.content = content;
 	this.alias = alias;
 	// Copy of the full string this token was created from
-	this.matchedStr = matchedStr || null;
+	this.length = (matchedStr || "").length|0;
 	this.greedy = !!greedy;
 };

@@ -2039,13 +2063,11 @@ Token.stringify = function(o, language, parent) {

 	_.hooks.run('wrap', env);

-	var attributes = '';
+	var attributes = Object.keys(env.attributes).map(function(name) {
+		return name + '="' + (env.attributes[name] || '').replace(/"/g, '&quot;') + '"';
+	}).join(' ');

-	for (var name in env.attributes) {
-		attributes += (attributes ? ' ' : '') + name + '="' + (env.attributes[name] || '') + '"';
-	}
-
-	return '<' + env.tag + ' class="' + env.classes.join(' ') + '" ' + attributes + '>' + env.content + '</' + env.tag + '>';
+	return '<' + env.tag + ' class="' + env.classes.join(' ') + '"' + (attributes ? ' ' + attributes : '') + '>' + env.content + '</' + env.tag + '>';

 };

@@ -2078,7 +2100,11 @@ if (script) {

 	if (document.addEventListener && !script.hasAttribute('data-manual')) {
 		if(document.readyState !== "loading") {
-			requestAnimationFrame(_.highlightAll, 0);
+			if (window.requestAnimationFrame) {
+				window.requestAnimationFrame(_.highlightAll);
+			} else {
+				window.setTimeout(_.highlightAll, 16);
+			}
 		}
 		else {
 			document.addEventListener('DOMContentLoaded', _.highlightAll);
@@ -2090,7 +2116,7 @@ return _self.Prism;

 })();

-if (typeof module !== 'undefined' && module.exports) {
+if ('object' !== 'undefined' && module.exports) {
 	module.exports = Prism;
 }

@@ -2107,10 +2133,10 @@ if (typeof commonjsGlobal !== 'undefined') {
 Prism.languages.markup = {
 	'comment': /<!--[\w\W]*?-->/,
 	'prolog': /<\?[\w\W]+?\?>/,
-	'doctype': /<!DOCTYPE[\w\W]+?>/,
+	'doctype': /<!DOCTYPE[\w\W]+?>/i,
 	'cdata': /<!\[CDATA\[[\w\W]*?]]>/i,
 	'tag': {
-		pattern: /<\/?(?!\d)[^\s>\/=.$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i,
+		pattern: /<\/?(?!\d)[^\s>\/=$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i,
 		inside: {
 			'tag': {
 				pattern: /^<\/?[^\s>\/]+/i,
@@ -2167,7 +2193,10 @@ Prism.languages.css = {
 	},
 	'url': /url\((?:(["'])(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1|.*?)\)/i,
 	'selector': /[^\{\}\s][^\{\};]*?(?=\s*\{)/,
-	'string': /("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/,
+	'string': {
+		pattern: /("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/,
+		greedy: true
+	},
 	'property': /(\b|\B)[\w-]+(?=\s*:)/i,
 	'important': /\B!important\b/i,
 	'function': /[-a-z0-9]+(?=\()/i,
@@ -2248,7 +2277,8 @@ Prism.languages.javascript = Prism.languages.extend('clike', {
 	'keyword': /\b(as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|var|void|while|with|yield)\b/,
 	'number': /\b-?(0x[\dA-Fa-f]+|0b[01]+|0o[0-7]+|\d*\.?\d+([Ee][+-]?\d+)?|NaN|Infinity)\b/,
 	// Allow for all non-ASCII characters (See http://stackoverflow.com/a/2008444)
-	'function': /[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*(?=\()/i
+	'function': /[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*(?=\()/i,
+	'operator': /--?|\+\+?|!=?=?|<=?|>=?|==?=?|&&?|\|\|?|\?|\*\*?|\/|~|\^|%|\.{3}/
 });

 Prism.languages.insertBefore('javascript', 'keyword', {
@@ -2437,6 +2467,7 @@ var OPTIONS$1 = {};
 var markdown = marked;
 var toc = [];
 var CACHE = {};
+var TIP_RE = /^!\s/;

 var renderTo = function (dom, content) {
  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
@@ -2486,6 +2517,10 @@ function init (options) {

    return ("<a href=\"" + href + "\" title=\"" + (title || '') + "\">" + text + "</a>")
  };
+  renderer.paragraph = function (text) {
+    var isTip = TIP_RE.test(text);
+    return isTip ? ("<p class=\"tip\">" + (text.replace(TIP_RE, '')) + "</p>") : ("<p>" + text + "</p>")
+  };

  if (typeof OPTIONS$1.markdown === 'function') {
    markdown.setOptions({ renderer: renderer });
@@ -2529,7 +2564,7 @@ function renderArticle (content) {
    var vm = new Vue({ el: 'main' }); // eslint-disable-line
    vm.$nextTick(function (_) { return scrollActiveSidebar(); });
  }
-  if (OPTIONS$1.auto2top) { scroll2Top(); }
+  if (OPTIONS$1.auto2top) { setTimeout(function () { return scroll2Top(OPTIONS$1.auto2top); }, 0); }
 }

 /**
@@ -2551,15 +2586,18 @@ function renderSidebar (content) {

  if (content) {
    html = markdown(content);
+    // find url tag
+    html = html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0];
  } else if (OPTIONS$1.sidebar) {
    html = tree(OPTIONS$1.sidebar, '<ul>');
  } else {
    html = tree(genTree(toc, OPTIONS$1.maxLevel), '<ul>');
  }

+  html = (OPTIONS$1.name ? ("<h1><a href=\"" + (OPTIONS$1.nameLink) + "\">" + (OPTIONS$1.name) + "</a></h1>") : '') + html;
  renderTo('aside.sidebar', html);
  var target = activeLink('aside.sidebar', true);
-  if (content) { renderSubSidebar(target); }
+  if (target) { renderSubSidebar(target); }
  toc = [];

  scrollActiveSidebar();
@@ -2580,18 +2618,18 @@ function renderCover (content) {
    return
  }
  renderCover.dom.classList.add('show');
-  if (renderCover.rendered) { return }
+  if (renderCover.rendered) { return sticky() }

  // render cover
  var html = markdown(content);
-  var match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)"></p>$');
+  var match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)">([^<]*?)</p>$');

  // render background
  if (match) {
    var coverEl = document.querySelector('section.cover');

    if (match[2] === 'color') {
-      coverEl.style.background = match[1];
+      coverEl.style.background = match[1] + (match[3] || '');
    } else {
      coverEl.classList.add('has-mask');
      coverEl.style.backgroundImage = "url(" + (match[1]) + ")";
@@ -2655,7 +2693,9 @@ var OPTIONS = merge({
  homepage: 'README.md',
  coverpage: '',
  basePath: '',
-  auto2top: false
+  auto2top: false,
+  name: '',
+  nameLink: window.location.pathname
 }, window.$docsify);
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();

@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "1.5.1",
+  "version": "1.7.1",
  "description": "A magical documentation generator.",
  "main": "lib/docsify.js",
  "files": [
@@ -35,9 +35,9 @@
    "nodemon": "^1.11.0",
    "postcss": "^5.2.6",
    "postcss-salad": "^1.0.5",
-    "rollup": "^0.36.3",
-    "rollup-plugin-buble": "^0.14.0",
-    "rollup-plugin-commonjs": "^5.0.5",
+    "rollup": "^0.41.1",
+    "rollup-plugin-buble": "^0.15.0",
+    "rollup-plugin-commonjs": "^7.0.0",
    "rollup-plugin-node-resolve": "^2.0.0",
    "rollup-plugin-uglify": "^1.0.1",
    "serve-static": "^1.11.1"
@@ -7,10 +7,12 @@ import { isMobile } from './util'
 export function scrollActiveSidebar () {
  if (isMobile()) return

+  let hoveredOverSidebar = false
  const anchors = document.querySelectorAll('.anchor')
+  const sidebar = document.querySelector('aside.sidebar')
  const nav = {}
-  const lis = document.querySelectorAll('.sidebar li')
-  let active = null
+  const lis = sidebar.querySelectorAll('li')
+  let active = sidebar.querySelector('li.active')

  for (let i = 0, len = lis.length; i < len; i += 1) {
    const li = lis[i]
@@ -25,27 +27,34 @@ export function scrollActiveSidebar () {
  }

  function highlight () {
+    const top = document.body.scrollTop
+    let last
+
    for (let i = 0, len = anchors.length; i < len; i += 1) {
      const node = anchors[i]
-      const bcr = node.getBoundingClientRect()

-      if (bcr.top < 10 && bcr.bottom > 10) {
-        const li = nav[node.getAttribute('data-id')]
-
-        if (!li || li === active) return
-        if (active) active.setAttribute('class', '')
-
-        li.setAttribute('class', 'active')
-        active = li
-
-        return
+      if (node.offsetTop > top) {
+        if (!last) last = node
+        break
+      } else {
+        last = node
      }
    }
+    if (!last) return
+    const li = nav[last.getAttribute('data-id')]
+
+    if (!li || li === active) return
+    if (active) active.classList.remove('active')
+
+    li.classList.add('active')
+    active = li
+    !hoveredOverSidebar && !sticky.noSticky && active.scrollIntoView(false)
  }

  window.removeEventListener('scroll', highlight)
  window.addEventListener('scroll', highlight)
-  highlight()
+  sidebar.addEventListener('mouseover', () => { hoveredOverSidebar = true })
+  sidebar.addEventListener('mouseleave', () => { hoveredOverSidebar = false })
 }

 export function scrollIntoView () {
@@ -53,7 +62,9 @@ export function scrollIntoView () {
  if (!id || !id.length) return
  const section = document.querySelector(decodeURIComponent(id[0]))

-  if (section) section.scrollIntoView()
+  if (section) setTimeout(() => section.scrollIntoView(), 0)
+
+  return section
 }

 /**
@@ -71,13 +82,13 @@ export function activeLink (dom, activeParent) {
    .forEach(node => {
      if (host.indexOf(node.href) === 0 && !target) {
        activeParent
-          ? node.parentNode.setAttribute('class', 'active')
-          : node.setAttribute('class', 'active')
+          ? node.parentNode.classList.add('active')
+          : node.classList.add('active')
        target = node
      } else {
        activeParent
-          ? node.parentNode.removeAttribute('class')
-          : node.removeAttribute('class')
+          ? node.parentNode.classList.remove('active')
+          : node.classList.remove('active')
      }
    })

@@ -95,24 +106,29 @@ export function bindToggle (dom) {
  dom.addEventListener('click', () => body.classList.toggle('close'))

  if (isMobile()) {
-    document.querySelector('aside')
-      .addEventListener('click', _ => body.classList.toggle('close'))
+    const sidebar = document.querySelector('aside.sidebar')
+    document.body.addEventListener('click', e => {
+      if (e.target !== dom && !dom.contains(e.target)) body.classList.toggle('close')
+      if (sidebar.contains(e.target)) setTimeout(() => activeLink(sidebar, true), 0)
+    })
  }
 }

-export function scroll2Top () {
-  document.body.scrollTop = 0
+export function scroll2Top (offset = 0) {
+  document.body.scrollTop = offset === true ? 0 : Number(offset)
 }

 export function sticky () {
-  const dom = document.querySelector('section.cover')
-  const coverHeight = dom.getBoundingClientRect().height
+  sticky.dom = sticky.dom || document.querySelector('section.cover')
+  const coverHeight = sticky.dom.getBoundingClientRect().height

  return (function () {
-    if (window.pageYOffset >= coverHeight || dom.classList.contains('hidden')) {
+    if (window.pageYOffset >= coverHeight || sticky.dom.classList.contains('hidden')) {
      document.body.classList.add('sticky')
+      sticky.noSticky = false
    } else {
      document.body.classList.remove('sticky')
+      sticky.noSticky = true
    }
  })()
 }
@@ -15,7 +15,9 @@ const OPTIONS = merge({
  homepage: 'README.md',
  coverpage: '',
  basePath: '',
-  auto2top: false
+  auto2top: false,
+  name: '',
+  nameLink: window.location.pathname
 }, window.$docsify)
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()

@@ -1,13 +1,14 @@
 import marked from 'marked'
 import Prism from 'prismjs'
 import * as tpl from './tpl'
-import { activeLink, scrollActiveSidebar, bindToggle, scroll2Top, sticky } from './event'
+import * as event from './event'
 import { genTree, getRoute, isMobile, slugify, merge } from './util'

 let OPTIONS = {}
 let markdown = marked
 let toc = []
 const CACHE = {}
+const TIP_RE = /^!\s/

 const renderTo = function (dom, content) {
  dom = typeof dom === 'object' ? dom : document.querySelector(dom)
@@ -55,6 +56,10 @@ export function init (options) {

    return `<a href="${href}" title="${title || ''}">${text}</a>`
  }
+  renderer.paragraph = function (text) {
+    const isTip = TIP_RE.test(text)
+    return isTip ? `<p class="tip">${text.replace(TIP_RE, '')}</p>` : `<p>${text}</p>`
+  }

  if (typeof OPTIONS.markdown === 'function') {
    markdown.setOptions({ renderer })
@@ -78,10 +83,10 @@ export function renderApp (dom, replace) {
  document.body.insertBefore(nav, document.body.children[0])

  // bind toggle
-  bindToggle('button.sidebar-toggle')
+  event.bindToggle('button.sidebar-toggle')
  // bind sticky effect
  if (OPTIONS.coverpage) {
-    !isMobile() && window.addEventListener('scroll', sticky)
+    !isMobile() && window.addEventListener('scroll', event.sticky)
  } else {
    document.body.classList.add('sticky')
  }
@@ -96,9 +101,9 @@ export function renderArticle (content) {

  if (content && typeof Vue !== 'undefined' && typeof Vuep !== 'undefined') {
    const vm = new Vue({ el: 'main' }) // eslint-disable-line
-    vm.$nextTick(_ => scrollActiveSidebar())
+    vm.$nextTick(_ => event.scrollActiveSidebar())
  }
-  if (OPTIONS.auto2top) scroll2Top()
+  if (OPTIONS.auto2top) setTimeout(() => event.scroll2Top(OPTIONS.auto2top), 0)
 }

 /**
@@ -109,7 +114,7 @@ export function renderNavbar (content) {
  CACHE.navbar = content

  if (content) renderTo('nav', markdown(content))
-  activeLink('nav')
+  event.activeLink('nav')
 }

 /**
@@ -120,18 +125,21 @@ export function renderSidebar (content) {

  if (content) {
    html = markdown(content)
+    // find url tag
+    html = html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0]
  } else if (OPTIONS.sidebar) {
    html = tpl.tree(OPTIONS.sidebar, '<ul>')
  } else {
    html = tpl.tree(genTree(toc, OPTIONS.maxLevel), '<ul>')
  }

+  html = (OPTIONS.name ? `<h1><a href="${OPTIONS.nameLink}">${OPTIONS.name}</a></h1>` : '') + html
  renderTo('aside.sidebar', html)
-  const target = activeLink('aside.sidebar', true)
-  if (content) renderSubSidebar(target)
+  const target = event.activeLink('aside.sidebar', true)
+  if (target) renderSubSidebar(target)
  toc = []

-  scrollActiveSidebar()
+  event.scrollActiveSidebar()
 }

 export function renderSubSidebar (target) {
@@ -149,18 +157,18 @@ export function renderCover (content) {
    return
  }
  renderCover.dom.classList.add('show')
-  if (renderCover.rendered) return
+  if (renderCover.rendered) return event.sticky()

  // render cover
  let html = markdown(content)
-  const match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)"></p>$')
+  const match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)">([^<]*?)</p>$')

  // render background
  if (match) {
    const coverEl = document.querySelector('section.cover')

    if (match[2] === 'color') {
-      coverEl.style.background = match[1]
+      coverEl.style.background = match[1] + (match[3] || '')
    } else {
      coverEl.classList.add('has-mask')
      coverEl.style.backgroundImage = `url(${match[1]})`
@@ -171,7 +179,7 @@ export function renderCover (content) {
  renderTo('.cover-main', html)
  renderCover.rendered = true

-  sticky()
+  event.sticky()
 }

 /**
@@ -96,6 +96,7 @@ nav {
    display: inline-block;

    ul {
+      border-radius: 2px;
      background-color: rgba($color-bg, .6);
      border: 1px solid $color-primary;
      opacity: 0;
@@ -160,6 +161,7 @@ nav {

 /* main */
 main {
+  display: block;
  size: 100vw 100%;
  position: relative;
 }
@@ -180,13 +182,34 @@ main {

 /* sidebar */
 .sidebar {
-  border-right: 1px solid rgba(0, 0, 0, .07);
  overflow-y: auto;
  padding: 40px 0;
  position: absolute 0 * 0 0;
  transition: transform 250ms ease-out;
  width: $sidebar-width;
  z-index: 20;
+  margin-bottom: 40px;
+
+  &::after {
+    content: '';
+    position: inherit;
+    left: calc($sidebar-width - 1px);
+    top: 0;
+    height: 100vh;
+    border-right: 1px solid rgba(0, 0, 0, .07);
+  }
+
+  > h1 {
+    text-align: center;
+    margin: 0 auto 1em;
+    font-size: 1.5em;
+    font-weight: 300;
+
+    a {
+      color: inherit;
+      text-decoration: none;
+    }
+  }

  ul {
    margin: 0;
@@ -291,6 +314,40 @@ body.sticky {
  }
 }

+.markdown-section p.tip {
+  padding: 12px 24px 12px 30px;
+  margin: 2em 0;
+  border-left: 4px solid #f66;
+  background-color: #f8f8f8;
+  position: relative;
+  border-bottom-right-radius: 2px;
+  border-top-right-radius: 2px;
+
+  &:before {
+    position: absolute;
+    top: 14px;
+    left: -12px;
+    background-color: #f66;
+    color: $color-bg;
+    content: "!";
+    size: 20px;
+    border-radius: 100%;
+    text-align: center;
+    line-height: 20px;
+    font-weight: bold;
+    font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
+    font-size: 14px;
+  }
+
+  code {
+    background-color: #efefef;
+  }
+
+  em {
+    color: $color-text;
+  }
+}
+
 body.close {
  .sidebar {
    transform: translateX(-$sidebar-width);
@@ -310,6 +367,15 @@ body.close {
    position: fixed;
  }

+  .sidebar {
+    margin-bottom: 0;
+    border-right: 1px solid rgba(0, 0, 0, .07);
+
+    &::after {
+      content: none;
+    }
+  }
+
  nav {
    margin-top: 16px;
  }
@@ -238,15 +238,3 @@ code .token {
  -webkit-font-smoothing: initial;
  -moz-osx-font-smoothing: initial;
 }
-
-.content span.light {
-  color: #7f8c8d;
-}
-
-.content span.info {
-  display: inline-block;
-  font-size: 0.85em;
-  margin-left: 20px;
-  vertical-align: middle;
-  width: 280px;
-}
@@ -285,15 +285,3 @@ pre::after {
  text-align: right;
  top: 0;
 }
-
-.content span.light {
-  color: #7f8c8d;
-}
-
-.content span.info {
-  display: inline-block;
-  font-size: 0.85em;
-  margin-left: 20px;
-  vertical-align: middle;
-  width: 280px;
-}
@@ -120,6 +120,8 @@ export function slugify (string) {
    .replace(/<[^>\d]+>/g, '')
    .replace(re, '')
    .replace(/\s/g, replacement)
+    .replace(/-+/g, replacement)
+    .replace(/^(\d)/, '_$1')
  let occurrences = slugify.occurrences[slug]

  if (slugify.occurrences.hasOwnProperty(slug)) {
Author	SHA1	Message	Date
qingwei.li	ff44152d12	-> v1.7.1	2017-01-12 20:46:24 +08:00
qingwei.li	b6bfad8579	bump 1.7.1	2017-01-12 20:46:04 +08:00
qingwei.li	e93f6b95ea	Fix sidebar style in mobile browser	2017-01-12 20:45:35 +08:00
qingwei.li	5c58629e69	Fix index.html	2017-01-12 20:34:47 +08:00
qingwei.li	55826691eb	-> v1.7.0	2017-01-12 20:30:13 +08:00
qingwei.li	64093c0567	bump 1.7.0	2017-01-12 20:29:45 +08:00
qingwei.li	c998fad98e	Add docs	2017-01-12 20:28:59 +08:00
qingwei.li	0a2e1ddf11	Tweak active item in sidebar	2017-01-12 20:23:55 +08:00
qingwei.li	4a7df99224	Add name link	2017-01-12 20:16:18 +08:00
qingwei.li	6c6f687925	Merge branch 'feat/data-name'	2017-01-12 19:48:21 +08:00
qingwei.li	ddc13aa280	Add changelog	2017-01-12 19:46:59 +08:00
qingwei.li	f997280ab1	Fix sticky sidebar	2017-01-12 19:46:28 +08:00
qingwei.li	458e262a26	Tweak style	2017-01-12 18:44:41 +08:00
qingwei.li	d971948f10	Add yarn.lock	2017-01-12 18:44:41 +08:00
qingwei.li	a309d3041e	Update docs	2017-01-12 18:44:41 +08:00
qingwei.li	557a165349	fixed custom cover background, fixed #52	2017-01-12 18:44:41 +08:00
Chao Leeandcinwell.li	d9eedf609e	add showcase at README.md (#53 )	2017-01-12 11:32:45 +08:00
qingwei.li	aa939147c6	Add name option	2017-01-11 18:11:49 +08:00
qingwei.li	67c1d0cd7d	Add yarn.lock	2017-01-11 16:53:08 +08:00
qingwei.li	06892e6de4	Update docs	2017-01-11 16:22:17 +08:00
qingwei.li	439a1e6841	fixed custom cover background, fixed #52	2017-01-11 16:18:43 +08:00
qingwei.li	f540e3c4fc	Add bash/markdown highlight	2017-01-10 23:55:58 +08:00
qingwei.li	2ffef062db	Update version number	2017-01-10 23:52:32 +08:00
qingwei.li	db7db5af8b	-> v1.6.1	2017-01-10 23:49:06 +08:00
qingwei.li	a418096a29	bump 1.6.1	2017-01-10 23:48:49 +08:00
qingwei.li	90b490c9c1	Fixed sidebar bug when the coverpage exist	2017-01-10 23:48:12 +08:00
qingwei.li	7915027418	-> v1.6.0	2017-01-10 23:34:20 +08:00
qingwei.li	87b373b841	bump 1.6.0	2017-01-10 23:33:41 +08:00
qingwei.li	510ae37a04	Add doc	2017-01-10 23:32:25 +08:00
qingwei.li	ef53a07f49	Add new markdown grammar & improve sidebar performance.	2017-01-10 23:16:55 +08:00
qingwei.li	9defe1bf7d	-> v1.5.2	2017-01-10 14:40:36 +08:00
qingwei.li	b87f6ae5e8	bump 1.5.2	2017-01-10 14:40:21 +08:00
qingwei.li	b8b9dbc872	Fixed number at the beginning of the slug, fixed #51	2017-01-10 14:39:40 +08:00