-> v1.7.0

bump 1.7.0
Add docs
2026-08-09 13:26:34 +10:00 · 2017-01-12 20:30:13 +08:00 · 2017-01-12 20:29:45 +08:00 · 2017-01-12 20:28:59 +08:00 · 2017-01-12 20:23:55 +08:00 · 2017-01-12 20:16:18 +08:00
19 changed files with 3646 additions and 88 deletions
@@ -1,5 +1,4 @@
 .DS_Store
 *.log
 node_modules
-yarn.lock
 /themes
@@ -1,3 +1,16 @@
+## 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.
@@ -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
 ```

@@ -433,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.6.0</small>
+# docsify <small>1.7.0</small>

 > A magical documentation site generator.

@@ -6,7 +6,7 @@
  <link rel="icon" href="favicon.ico">
  <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">
+  <link rel="stylesheet" href="/lib/themes/vue.css">
 </head>
 <body>
  <nav>
@@ -16,9 +16,12 @@
  <div id="app"></div>
 </body>
 <script
-  src="//unpkg.com/docsify/lib/docsify.min.js"
+  src="/lib/docsify.min.js"
  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
 ```

@@ -437,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: '/'
+}
+```
+
@@ -216,7 +216,7 @@ function scrollActiveSidebar () {

    li.classList.add('active');
    active = li;
-    !hoveredOverSidebar && active.scrollIntoView();
+    !hoveredOverSidebar && !sticky.noSticky && active.scrollIntoView(false);
  }

  window.removeEventListener('scroll', highlight);
@@ -287,14 +287,16 @@ function scroll2Top (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;
    }
  })()
 }
@@ -1597,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() {
@@ -1820,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;
 		}
@@ -1897,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];

@@ -1919,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) {
@@ -2021,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;
 };

@@ -2057,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 + '>';

 };

@@ -2096,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);
@@ -2108,7 +2116,7 @@ return _self.Prism;

 })();

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

@@ -2125,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,
@@ -2185,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,
@@ -2266,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', {
@@ -2574,12 +2586,15 @@ 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 (target) { renderSubSidebar(target); }
@@ -2603,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]) + ")";
@@ -2678,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.6.0",
+  "version": "1.7.0",
  "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"
@@ -48,7 +48,7 @@ export function scrollActiveSidebar () {

    li.classList.add('active')
    active = li
-    !hoveredOverSidebar && active.scrollIntoView()
+    !hoveredOverSidebar && !sticky.noSticky && active.scrollIntoView(false)
  }

  window.removeEventListener('scroll', highlight)
@@ -119,14 +119,16 @@ export function scroll2Top (offset = 0) {
 }

 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()

@@ -125,12 +125,15 @@ 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 = event.activeLink('aside.sidebar', true)
  if (target) renderSubSidebar(target)
@@ -154,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]})`
@@ -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: $sidebar-width;
+    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;
Author	SHA1	Message	Date
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