-> v1.9.0

bump 1.9.0
1.9 (#62 )
2026-08-09 05:16:06 +10:00 · 2017-01-24 22:31:44 +08:00 · 2017-01-24 22:31:27 +08:00 · 2017-01-24 22:29:50 +08:00 · 2017-01-24 11:28:15 +08:00 · 2017-01-24 11:28:04 +08:00
19 changed files with 227 additions and 53 deletions
@@ -1,3 +1,38 @@
+## 1.9.0
+
+### Bug fixes
+- Destroys the vue instance when the route is changed
+
+### Features
+- Add `!>` and `?>` doc helper.
+
+### Break change
+- Remove `!` doc helper.
+
+## 1.8.0
+### Bug fixes
+- Using `v-pre` skip compilation.
+
+### Features
+- Execute script when vue exists.
+
+## 1.7.4
+### Bug fixes
+- Fix bugs caused by the previous version
+
+## 1.7.3
+### Bug fixes
+- Add `hr` style
+- Fixed option is an empty string
+
+## 1.7.2
+### Bug fixes
+- Fix sidebar click event in mobile browser.
+
+## 1.7.1
+### Bug fixes
+- Fix sidebar style in mobile browser.
+
 ## 1.7.0

 ### Bug fixes
@@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2016 cinwell.li
+Copyright (c) 2016 - 2017 cinwell.li

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -53,6 +53,8 @@ These open-source projects are using docsify to generate their sites. Pull reque
 - [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.
+- [Vudash](http://vudash.github.io/vudash/) - Powerful, Flexible, Open Source dashboards for anything
+- [Trilogy](http://trilogy.js.org) - No-hassle SQLite with a Promise-based, document store style API.

 ## Similar projects
 - [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
@@ -160,10 +160,10 @@ window.$docsify = {
 ### Doc Helpers
 #### p.tip

-'! ' add your content will rendered as `<p class="tip">content</p>`
+`!> ` add your content will rendered as `<p class="tip">content</p>`

 ```markdown
-! Important **information**
+!> Important **information**
 ```

 It will be rendered
@@ -174,9 +174,48 @@ It will be rendered

 e.g.

-! Important **information**
+!> Important **information**


+#### p.warn
+
+```markdown
+?> todo info
+```
+
+?> todo info
+
+### Combining Vue
+We can write the Vue syntax directly in the markdown file, when the Vue library is loaded into `index.html`. Default will automatically initialize a Vue instance, of course, we can also manually.
+
+index.html
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify" data-router></script>
+```
+
+```markdown
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+Manual initialization
+
+```markdown
+<div>
+  <input type="text" v-model="msg">
+  <p>Hello, {{ msg }}</p>
+</div>
+
+<script>
+  new Vue({
+    el: 'main',
+    data: { msg: 'Docsify' }
+  })
+</script>
+```
+
 ## Options

 You can add configurations in the script tag attributes or with `window.$docsify`.
@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)

-# docsify <small>1.7.0</small>
+# docsify <small>1.9.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="/lib/themes/vue.css">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
 </head>
 <body>
  <nav>
@@ -16,7 +16,7 @@
  <div id="app"></div>
 </body>
 <script
-  src="/lib/docsify.min.js"
+  src="//unpkg.com/docsify/lib/docsify.min.js"
  data-max-level="4"
  data-sidebar-toggle
  data-coverpage
@@ -166,10 +166,10 @@ window.$docsify = {
 ### 文档助手
 #### 内置「提示」语法

-感叹号加空格，后面接内容，会渲染成带 tip 类名的段落。
+`!>`后面接内容，会渲染成带 tip 类名的段落。

 ```markdown
-! 提示信息，**支持其他 markdown 语法**
+!> 提示信息，**支持其他 markdown 语法**
 ```

 将被渲染成
@@ -180,7 +180,51 @@ window.$docsify = {

 效果

-! 适合显示醒目的内容
+!> 适合显示醒目的内容
+
+#### 内置「警示」语法
+
+`?>`后面接内容，会渲染成带 warn 类名的段落。
+
+```markdown
+?> 警示内容样式
+```
+
+效果
+
+?> 警示内容样式
+
+### 结合 Vue
+
+`index.html` 内引入 Vue 后，可以在文档里直接写 Vue 语法。默认会自己初始化一个 Vue 示例，当然我们也可以手动初始化一个实例。
+
+index.html
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify" data-router></script>
+```
+
+```markdown
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+手动初始化示例
+
+```markdown
+<div>
+  <input type="text" v-model="msg">
+  <p>Hello, {{ msg }}</p>
+</div>
+
+<script>
+  new Vue({
+    el: 'main',
+    data: { msg: 'Docsify' }
+  })
+</script>
+```

 ## 配置参数

@@ -273,9 +273,9 @@ function bindToggle (dom) {

  if (isMobile()) {
    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); }
+    sidebar.addEventListener('click', function () {
+      body.classList.toggle('close');
+      setTimeout(function () { return activeLink(sidebar, true); }, 0);
    });
  }
 }
@@ -2463,11 +2463,14 @@ function tree (toc, tpl) {
  return tpl
 }

+function helper (className, content) {
+  return ("<p class=\"" + className + "\">" + (content.slice(5).trim()) + "</p>")
+}
+
 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);
@@ -2505,10 +2508,9 @@ function init (options) {
  renderer.code = function (code, lang) {
    if ( lang === void 0 ) lang = '';

-    var hl = prism.highlight(code, prism.languages[lang] || prism.languages.markup)
-      .replace(/{{/g, '<span>{{</span>');
+    var hl = prism.highlight(code, prism.languages[lang] || prism.languages.markup);

-    return ("<pre data-lang=\"" + lang + "\"><code class=\"lang-" + lang + "\">" + hl + "</code></pre>")
+    return ("<pre v-pre data-lang=\"" + lang + "\"><code class=\"lang-" + lang + "\">" + hl + "</code></pre>")
  };
  renderer.link = function (href, title, text) {
    if (OPTIONS$1.router && !/:/.test(href)) {
@@ -2518,8 +2520,12 @@ 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 (/^!&gt;/.test(text)) {
+      return helper('tip', text)
+    } else if (/^\?&gt;/.test(text)) {
+      return helper('warn', text)
+    }
+    return ("<p>" + text + "</p>")
  };

  if (typeof OPTIONS$1.markdown === 'function') {
@@ -2560,9 +2566,15 @@ function renderArticle (content) {
  renderTo('article', content ? markdown(content) : 'not found');
  if (!OPTIONS$1.sidebar && !OPTIONS$1.loadSidebar) { renderSidebar(); }

-  if (content && typeof Vue !== 'undefined' && typeof Vuep !== 'undefined') {
-    var vm = new Vue({ el: 'main' }); // eslint-disable-line
-    vm.$nextTick(function (_) { return scrollActiveSidebar(); });
+  if (content && typeof Vue !== 'undefined') {
+    var script = content.match('<script[^>]*?>([^<]+)</script>');
+
+    script && document.body.querySelector('article script').remove();
+    CACHE.vm && CACHE.vm.$destroy();
+    CACHE.vm = script
+      ? new Function(("return " + (script[1].trim())))()
+      : new Vue({ el: 'main' }); // eslint-disable-line
+    CACHE.vm && CACHE.vm.$nextTick(function (_) { return scrollActiveSidebar(); });
  }
  if (OPTIONS$1.auto2top) { setTimeout(function () { return scroll2Top(OPTIONS$1.auto2top); }, 0); }
 }
@@ -2621,9 +2633,12 @@ function renderCover (content) {
  if (renderCover.rendered) { return sticky() }

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

+  toc = cacheToc.slice();
+
  // render background
  if (match) {
    var coverEl = document.querySelector('section.cover');
@@ -2708,6 +2723,8 @@ if (script) {
  if (OPTIONS.loadSidebar === true) { OPTIONS.loadSidebar = '_sidebar.md'; }
  if (OPTIONS.loadNavbar === true) { OPTIONS.loadNavbar = '_navbar.md'; }
  if (OPTIONS.coverpage === true) { OPTIONS.coverpage = '_coverpage.md'; }
+  if (OPTIONS.repo === true) { OPTIONS.repo = ''; }
+  if (OPTIONS.name === true) { OPTIONS.name = ''; }
  if (OPTIONS.sidebar) { OPTIONS.sidebar = window[OPTIONS.sidebar]; }
 }

@@ -2752,11 +2769,10 @@ var mainRender = function (cb) {
    if (OPTIONS.coverpage && page !== OPTIONS.homepage) { renderCover(); }
    // render sidebar
    if (OPTIONS.loadSidebar) {
-      load(basePath + OPTIONS.loadSidebar)
-        .then(function (result) {
-          renderSidebar(result);
-          cb();
-        });
+      var renderSidebar$$1 = function (result) { renderSidebar(result); cb(); };
+
+      load(basePath + OPTIONS.loadSidebar).then(renderSidebar$$1,
+        function (_) { return load(OPTIONS.loadSidebar).then(renderSidebar$$1); });
    } else {
      cb();
    }
@@ -2764,7 +2780,8 @@ var mainRender = function (cb) {

  // Render navbar
  if (OPTIONS.loadNavbar) {
-    load(basePath + OPTIONS.loadNavbar).then(renderNavbar);
+    load(basePath + OPTIONS.loadNavbar).then(renderNavbar,
+      function (_) { return load(OPTIONS.loadNavbar).then(renderNavbar); });
  }
 };

@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "1.7.0",
+  "version": "1.9.0",
  "description": "A magical documentation generator.",
  "main": "lib/docsify.js",
  "files": [
@@ -107,9 +107,9 @@ export function bindToggle (dom) {

  if (isMobile()) {
    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)
+    sidebar.addEventListener('click', () => {
+      body.classList.toggle('close')
+      setTimeout(() => activeLink(sidebar, true), 0)
    })
  }
 }
@@ -30,6 +30,8 @@ if (script) {
  if (OPTIONS.loadSidebar === true) OPTIONS.loadSidebar = '_sidebar.md'
  if (OPTIONS.loadNavbar === true) OPTIONS.loadNavbar = '_navbar.md'
  if (OPTIONS.coverpage === true) OPTIONS.coverpage = '_coverpage.md'
+  if (OPTIONS.repo === true) OPTIONS.repo = ''
+  if (OPTIONS.name === true) OPTIONS.name = ''
  if (OPTIONS.sidebar) OPTIONS.sidebar = window[OPTIONS.sidebar]
 }

@@ -74,11 +76,10 @@ const mainRender = function (cb) {
    if (OPTIONS.coverpage && page !== OPTIONS.homepage) render.renderCover()
    // render sidebar
    if (OPTIONS.loadSidebar) {
-      load(basePath + OPTIONS.loadSidebar)
-        .then(result => {
-          render.renderSidebar(result)
-          cb()
-        })
+      const renderSidebar = result => { render.renderSidebar(result); cb() }
+
+      load(basePath + OPTIONS.loadSidebar).then(renderSidebar,
+        _ => load(OPTIONS.loadSidebar).then(renderSidebar))
    } else {
      cb()
    }
@@ -86,7 +87,8 @@ const mainRender = function (cb) {

  // Render navbar
  if (OPTIONS.loadNavbar) {
-    load(basePath + OPTIONS.loadNavbar).then(render.renderNavbar)
+    load(basePath + OPTIONS.loadNavbar).then(render.renderNavbar,
+      _ => load(OPTIONS.loadNavbar).then(render.renderNavbar))
  }
 }

@@ -8,7 +8,6 @@ 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)
@@ -45,9 +44,8 @@ export function init (options) {
  // highlight code
  renderer.code = function (code, lang = '') {
    const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
-      .replace(/{{/g, '<span>{{</span>')

-    return `<pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
+    return `<pre v-pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
  }
  renderer.link = function (href, title, text) {
    if (OPTIONS.router && !/:/.test(href)) {
@@ -57,8 +55,12 @@ 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 (/^!&gt;/.test(text)) {
+      return tpl.helper('tip', text)
+    } else if (/^\?&gt;/.test(text)) {
+      return tpl.helper('warn', text)
+    }
+    return `<p>${text}</p>`
  }

  if (typeof OPTIONS.markdown === 'function') {
@@ -99,9 +101,15 @@ export function renderArticle (content) {
  renderTo('article', content ? markdown(content) : 'not found')
  if (!OPTIONS.sidebar && !OPTIONS.loadSidebar) renderSidebar()

-  if (content && typeof Vue !== 'undefined' && typeof Vuep !== 'undefined') {
-    const vm = new Vue({ el: 'main' }) // eslint-disable-line
-    vm.$nextTick(_ => event.scrollActiveSidebar())
+  if (content && typeof Vue !== 'undefined') {
+    const script = content.match('<script[^>]*?>([^<]+)</script>')
+
+    script && document.body.querySelector('article script').remove()
+    CACHE.vm && CACHE.vm.$destroy()
+    CACHE.vm = script
+      ? new Function(`return ${script[1].trim()}`)()
+      : new Vue({ el: 'main' }) // eslint-disable-line
+    CACHE.vm && CACHE.vm.$nextTick(_ => event.scrollActiveSidebar())
  }
  if (OPTIONS.auto2top) setTimeout(() => event.scroll2Top(OPTIONS.auto2top), 0)
 }
@@ -160,9 +168,12 @@ export function renderCover (content) {
  if (renderCover.rendered) return event.sticky()

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

+  toc = cacheToc.slice()
+
  // render background
  if (match) {
    const coverEl = document.querySelector('section.cover')
@@ -193,7 +193,7 @@ main {
  &::after {
    content: '';
    position: inherit;
-    left: $sidebar-width;
+    left: calc($sidebar-width - 1px);
    top: 0;
    height: 100vh;
    border-right: 1px solid rgba(0, 0, 0, .07);
@@ -287,6 +287,12 @@ body.sticky {
  }
 }

+.markdown-section hr {
+  border: none;
+  margin: 2em 0;
+  border-bottom: 1px solid #eee;
+}
+
 .markdown-section table {
  display: block;
  width: 100%;
@@ -348,6 +354,12 @@ body.sticky {
  }
 }

+.markdown-section p.warn {
+  padding: 1em;
+  background: rgba($color-primary, 0.1);
+  border-radius: 2px;
+}
+
 body.close {
  .sidebar {
    transform: translateX(-$sidebar-width);
@@ -367,6 +379,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;
  }
@@ -28,7 +28,7 @@ $sidebar-width: 16em;
    padding: 0;
  }

-  .active {
+  li.active {
    background-color: #eee;

    a {
@@ -72,3 +72,6 @@ export function tree (toc, tpl = '') {
  return tpl
 }

+export function helper (className, content) {
+  return `<p class="${className}">${content.slice(5).trim()}</p>`
+}
Author	SHA1	Message	Date
qingwei.li	7c4b0b7c74	-> v1.9.0	2017-01-24 22:31:44 +08:00
qingwei.li	98d1b19bea	bump 1.9.0	2017-01-24 22:31:27 +08:00
cinwell.liandGitHub	0709239c77	1.9 (#62 ) * Destroys the vue instance when the route is changed * Add new doc helper * Update docs	2017-01-24 22:29:50 +08:00
qingwei.li	73cc43c6bd	-> v1.8.0	2017-01-24 11:28:15 +08:00
qingwei.li	9d096b03a4	bump 1.8.0	2017-01-24 11:28:04 +08:00
qingwei.li	2af035ff45	Fix fallback sidebar	2017-01-24 10:18:58 +08:00
qingwei.li	3979f5cd3f	Update change log	2017-01-24 10:07:14 +08:00
qingwei.li	9abae495ac	Execute script when vue exists.	2017-01-24 10:06:38 +08:00
qingwei.li	d179ade7df	Using v-pre	2017-01-18 16:35:19 +08:00
qingwei.li	d79c7655cd	Update license	2017-01-18 16:34:05 +08:00
citycideandcinwell.li	af5d2934e4	add `Trilogy` to showcase list (#58 )	2017-01-17 08:05:12 +08:00
Antony Jonesandcinwell.li	129bd4d3a0	Add vudash to list of projects using docsify (#57 )	2017-01-15 18:45:32 +08:00
qingwei.li	abaf5c0849	-> v1.7.4	2017-01-13 23:33:20 +08:00
qingwei.li	336efb30cb	bump 1.7.4	2017-01-13 23:33:04 +08:00
qingwei.li	fb8bf89d73	Fix bugs caused by the previous version, fixed #56	2017-01-13 23:32:38 +08:00
qingwei.li	8630591bd2	-> v1.7.3	2017-01-13 23:06:31 +08:00
qingwei.li	c47ff83073	bump 1.7.3	2017-01-13 23:06:18 +08:00
cinwell.liandGitHub	69e500bd33	Fix repo (#55 ) * Fix option is an empty string * Fix test * Add hr style #54 * Tweak hr style	2017-01-13 23:05:05 +08:00
qingwei.li	000a1fcdf0	-> v1.7.2	2017-01-12 21:31:40 +08:00
qingwei.li	b84544960f	bump 1.7.2	2017-01-12 21:31:22 +08:00
qingwei.li	28a004840d	Fix sidebar click event in mobile browser	2017-01-12 21:30:33 +08:00
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