-> v1.1.5

bump 1.1.5
Correct calculation of whether the mobile browser
2026-08-09 21:36:10 +10:00 · 2016-12-18 10:50:37 +08:00 · 2016-12-18 10:50:02 +08:00 · 2016-12-18 10:49:21 +08:00 · 2016-12-18 10:37:34 +08:00 · 2016-12-17 16:08:45 +08:00
19 changed files with 288 additions and 57 deletions
@@ -1,3 +1,6 @@
 sudo: false
+cache:
+  directories:
+  - $HOME/.yarn-cache
 language: node_js
 node_js: stable
@@ -8,5 +8,5 @@
 <body class="">
  <div id="app"></div>
 </body>
-<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-sidebar-toggle data-router></script>
+<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-auto2top data-sidebar-toggle data-router></script>
 </html>
@@ -1,3 +1,33 @@
+## 1.1.5
+### Features
+- Add table style
+
+### Bug fixes
+- Not fixed position of hte navbar in the mobile browser
+- Correct calculation of whether the mobile browser
+
+## 1.1.4
+### Bug fixes
+- Fixed chinese auchor link
+
+## 1.1.3
+### Bug fixes
+- Optimize progress bar again
+
+## 1.1.2
+### Bug fixes
+- fix failed `auto2top` in mobile
+
+
+## 1.1.1
+### Bug fixes
+- Optimize progress bar
+
+## 1.1.0
+## Features
+- Add progress bar
+- Add `auto2top` option for hash router
+
 ## 1.0.3
 ### Bug fixes
 - Fix cache
@@ -25,7 +25,9 @@ Create a `404.html` and `README.md` into `/docs`.
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
-<body></body>
+<body>
+  <div id="app"></div>
+</body>
 <script src="//unpkg.com/docsify"></script>
 </html>
 ```
@@ -41,7 +43,9 @@ index.html
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
-<body></body>
+<body>
+  <div id="app"></div>
+</body>
 <script src="//unpkg.com/docsify" data-router></script>
 </html>
 ```
@@ -60,3 +64,8 @@ These open-source projects are using docsify to generate their sites. Pull reque

 ## License
 MIT
+
+## Support on Beerpay
+Hey dude! Help me out for a couple of :beers:!
+
+[![Beerpay](https://beerpay.io/QingWei-Li/docsify/badge.svg?style=beer-square)](https://beerpay.io/QingWei-Li/docsify)  [![Beerpay](https://beerpay.io/QingWei-Li/docsify/make-wish.svg?style=flat-square)](https://beerpay.io/QingWei-Li/docsify?focus=wish)
@@ -220,3 +220,13 @@ Hash router. You can replace `404.html` with `index.html`.
 ```html
 <script src="/lib/docsify.js" data-router></script>
 ```
+
+### auto2top
+
+Scroll to the top on changing hash.
+
+
+```html
+<script src="/lib/docsify.js" data-auto2top></script>
+```
+
@@ -221,3 +221,13 @@ Sidebar 开关按钮
 ```html
 <script src="/lib/docsify.js" data-router></script>
 ```
+
+### auto2top
+
+切换路由时自动跳转到页面顶部
+
+
+```html
+<script src="/lib/docsify.js" data-auto2top></script>
+```
+
@@ -4,11 +4,12 @@ var Docsify = (function () {
 /**
 * Simple ajax
 * @param  {String} url
- * @param  {String} [method=get]
+ * @param  {String} [method=GET]
+ * @param {Function} [loading] handle loading
 * @return {Promise}
 */
-function load (url, method) {
-  if ( method === void 0 ) method = 'get';
+function load (url, method, loading) {
+  if ( method === void 0 ) method = 'GET';

  var xhr = new XMLHttpRequest();

@@ -19,13 +20,18 @@ function load (url, method) {
    then: function (success, error) {
      if ( error === void 0 ) error = function () {};

+      if (loading) {
+        xhr.addEventListener('progress', loading);
+        xhr.addEventListener('loaded', loading);
+      }
      xhr.addEventListener('error', error);
      xhr.addEventListener('load', function (ref) {
        var target = ref.target;

        target.status >= 400 ? error(target) : success(target.response);
      });
-    }
+    },
+    abort: function () { return xhr.readyState !== 4 && xhr.abort(); }
  }
 }

@@ -99,12 +105,16 @@ function getRoute () {
  return route
 }

+function isMobile () {
+  return document.body.clientWidth <= 600
+}
+
 /**
 * Active sidebar when scroll
 * @link https://buble.surge.sh/
 */
 function scrollActiveSidebar () {
-  if (/mobile/i.test(navigator.userAgent)) { return }
+  if (isMobile()) { return }

  var anchors = document.querySelectorAll('.anchor');
  var nav = {};
@@ -148,7 +158,7 @@ function scrollActiveSidebar () {
 function scrollIntoView () {
  var id = window.location.hash.match(/#[^#\/]+$/g);
  if (!id || !id.length) { return }
-  var section = document.querySelector(id[0]);
+  var section = document.querySelector(decodeURIComponent(id[0]));

  if (section) { section.scrollIntoView(); }
 }
@@ -191,6 +201,15 @@ function bindToggle (dom) {
  });
 }

+var cacheContentDOM;
+function scroll2Top () {
+  if (!cacheContentDOM) {
+    var dom = isMobile() ? 'body' : 'section.content';
+    cacheContentDOM = document.querySelector(dom);
+  }
+  cacheContentDOM.scrollTop = 0;
+}
+
 var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};


@@ -2349,14 +2368,16 @@ var renderer = new marked.Renderer();
 * @link https://github.com/chjj/marked#overriding-renderer-methods
 */
 renderer.heading = function (text, level) {
-  var slug = text.toLowerCase().replace(/<(?:.|\n)*?>/gm, '').replace(/[^\w|\u4e00-\u9fa5]+/g, '-');
+  var slug = text.toLowerCase()
+      .replace(/<(?:.|\n)*?>/gm, '')
+      .replace(/[^\w|\u4e00-\u9fa5]+/g, '-');
  var route = '';

  if (OPTIONS$1.router) {
    route = "#/" + (getRoute());
  }

-  toc.push({ level: level, slug: (route + "#" + slug), title: text });
+  toc.push({ level: level, slug: (route + "#" + (encodeURIComponent(slug))), title: text });

  return ("<h" + level + " id=\"" + slug + "\"><a href=\"" + route + "#" + slug + "\" class=\"anchor\"></a>" + text + "</h" + level + ">")
 };
@@ -2399,14 +2420,16 @@ function renderArticle (content) {
  if (!renderNavbar.rendered) { renderNavbar(null, OPTIONS$1); }
  renderSidebar.rendered = false;
  renderNavbar.rendered = false;
+
+  if (OPTIONS$1.auto2top) { scroll2Top(); }
 }

 /**
 * navbar
 */
 function renderNavbar (content) {
-  if (CACHE['navbar'] && CACHE['navbar'] === content) { return }
-  CACHE['navbar'] = content;
+  if (CACHE.navbar && CACHE.navbar === content) { return }
+  CACHE.navbar = content;
  renderNavbar.rendered = true;

  if (content) { renderTo('nav', marked(content)); }
@@ -2429,13 +2452,47 @@ function renderSidebar (content) {
  }

  renderSidebar.rendered = true;
-  if (CACHE['sidebar'] && CACHE['sidebar'] === content) { return }
-  CACHE['sidebar'] = content;
+  if (CACHE.sidebar && CACHE.sidebar === content) { return }
+  CACHE.sidebar = content;
  renderTo('aside.sidebar', content);
  if (isToc) { scrollActiveSidebar(); }
  toc = [];
 }

+/**
+ * render loading bar
+ * @return {[type]} [description]
+ */
+function renderLoading (ref) {
+  var loaded = ref.loaded;
+  var total = ref.total;
+
+  var num = Math.floor(loaded / total * 100);
+
+  if (!CACHE.loading) {
+    var div = document.createElement('div');
+
+    div.classList.add('progress');
+    document.body.appendChild(div);
+    CACHE.loading = div;
+  }
+
+  CACHE.loading.style.opacity = 1;
+  CACHE.loading.style.width = num >= 95 ? '100%' : num + '%';
+
+  if (num >= 95) {
+    clearTimeout(renderLoading.cacheTImeout);
+    renderLoading.cacheTImeout = setTimeout(function (_) {
+      CACHE.loading.style.opacity = 0;
+      CACHE.loading.style.width = '0%';
+    }, 200);
+  }
+}
+
+/**
+ * Load Config
+ * @param  {Object} options
+ */
 function config (options) {
  OPTIONS$1 = options;
 }
@@ -2448,7 +2505,8 @@ var OPTIONS = {
  sidebarToggle: false,
  loadSidebar: null,
  loadNavbar: null,
-  router: false
+  router: false,
+  auto2top: false
 };
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();

@@ -2467,6 +2525,7 @@ if (script) {
 config(OPTIONS);

 var cacheRoute = null;
+var cacheXhr = null;

 var mainRender = function (cb) {
  var route = getRoute();
@@ -2480,17 +2539,22 @@ var mainRender = function (cb) {
    basePath = basePath.match(/(\S*\/)[^\/]+$/)[1];
  }

+  cacheXhr && cacheXhr.abort && cacheXhr.abort();
  // Render markdown file
-  load((!route || /\/$/.test(route)) ? (route + "README.md") : (route + ".md"))
-    .then(function (result) {
-      renderArticle(result);
-      if (OPTIONS.loadSidebar) {
-        if (wait === false) { cb(); }
-        wait = false;
-      } else {
-        cb();
-      }
-    }, function (_) { return renderArticle(null); });
+  cacheXhr = load(
+    (!route || /\/$/.test(route)) ? (route + "README.md") : (route + ".md"),
+    'GET',
+    renderLoading);
+
+  cacheXhr.then(function (result) {
+    renderArticle(result);
+    if (OPTIONS.loadSidebar) {
+      if (wait === false) { cb(); }
+      wait = false;
+    } else {
+      cb();
+    }
+  }, function (_) { return renderArticle(null); });

  // Render sidebar
  if (OPTIONS.loadSidebar) {
@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "1.0.3",
+  "version": "1.1.5",
  "description": "A magical documentation generator.",
  "main": "lib/docsify.js",
  "files": [
@@ -1,10 +1,11 @@
+import { isMobile } from './util'

 /**
 * Active sidebar when scroll
 * @link https://buble.surge.sh/
 */
 export function scrollActiveSidebar () {
-  if (/mobile/i.test(navigator.userAgent)) return
+  if (isMobile()) return

  const anchors = document.querySelectorAll('.anchor')
  const nav = {}
@@ -48,7 +49,7 @@ export function scrollActiveSidebar () {
 export function scrollIntoView () {
  const id = window.location.hash.match(/#[^#\/]+$/g)
  if (!id || !id.length) return
-  const section = document.querySelector(id[0])
+  const section = document.querySelector(decodeURIComponent(id[0]))

  if (section) section.scrollIntoView()
 }
@@ -90,3 +91,12 @@ export function bindToggle (dom) {
    body.classList.toggle('close')
  })
 }
+
+let cacheContentDOM
+export function scroll2Top () {
+  if (!cacheContentDOM) {
+    const dom = isMobile() ? 'body' : 'section.content'
+    cacheContentDOM = document.querySelector(dom)
+  }
+  cacheContentDOM.scrollTop = 0
+}
@@ -10,7 +10,8 @@ const OPTIONS = {
  sidebarToggle: false,
  loadSidebar: null,
  loadNavbar: null,
-  router: false
+  router: false,
+  auto2top: false
 }
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()

@@ -29,6 +30,7 @@ if (script) {
 render.config(OPTIONS)

 let cacheRoute = null
+let cacheXhr = null

 const mainRender = function (cb) {
  const route = getRoute()
@@ -42,17 +44,22 @@ const mainRender = function (cb) {
    basePath = basePath.match(/(\S*\/)[^\/]+$/)[1]
  }

+  cacheXhr && cacheXhr.abort && cacheXhr.abort()
  // Render markdown file
-  load((!route || /\/$/.test(route)) ? `${route}README.md` : `${route}.md`)
-    .then(result => {
-      render.renderArticle(result)
-      if (OPTIONS.loadSidebar) {
-        if (wait === false) cb()
-        wait = false
-      } else {
-        cb()
-      }
-    }, _ => render.renderArticle(null))
+  cacheXhr = load(
+    (!route || /\/$/.test(route)) ? `${route}README.md` : `${route}.md`,
+    'GET',
+    render.renderLoading)
+
+  cacheXhr.then(result => {
+    render.renderArticle(result)
+    if (OPTIONS.loadSidebar) {
+      if (wait === false) cb()
+      wait = false
+    } else {
+      cb()
+    }
+  }, _ => render.renderArticle(null))

  // Render sidebar
  if (OPTIONS.loadSidebar) {
@@ -1,7 +1,7 @@
 import marked from 'marked'
 import Prism from 'prismjs'
 import * as tpl from './tpl'
-import { activeLink, scrollActiveSidebar, bindToggle } from './event'
+import { activeLink, scrollActiveSidebar, bindToggle, scroll2Top } from './event'
 import { genTree, getRoute } from './util'

 let OPTIONS = {}
@@ -21,14 +21,16 @@ const renderer = new marked.Renderer()
 * @link https://github.com/chjj/marked#overriding-renderer-methods
 */
 renderer.heading = function (text, level) {
-  const slug = text.toLowerCase().replace(/<(?:.|\n)*?>/gm, '').replace(/[^\w|\u4e00-\u9fa5]+/g, '-')
+  const slug = text.toLowerCase()
+      .replace(/<(?:.|\n)*?>/gm, '')
+      .replace(/[^\w|\u4e00-\u9fa5]+/g, '-')
  let route = ''

  if (OPTIONS.router) {
    route = `#/${getRoute()}`
  }

-  toc.push({ level, slug: `${route}#${slug}`, title: text })
+  toc.push({ level, slug: `${route}#${encodeURIComponent(slug)}`, title: text })

  return `<h${level} id="${slug}"><a href="${route}#${slug}" class="anchor"></a>${text}</h${level}>`
 }
@@ -69,14 +71,16 @@ export function renderArticle (content) {
  if (!renderNavbar.rendered) renderNavbar(null, OPTIONS)
  renderSidebar.rendered = false
  renderNavbar.rendered = false
+
+  if (OPTIONS.auto2top) scroll2Top()
 }

 /**
 * navbar
 */
 export function renderNavbar (content) {
-  if (CACHE['navbar'] && CACHE['navbar'] === content) return
-  CACHE['navbar'] = content
+  if (CACHE.navbar && CACHE.navbar === content) return
+  CACHE.navbar = content
  renderNavbar.rendered = true

  if (content) renderTo('nav', marked(content))
@@ -99,13 +103,45 @@ export function renderSidebar (content) {
  }

  renderSidebar.rendered = true
-  if (CACHE['sidebar'] && CACHE['sidebar'] === content) return
-  CACHE['sidebar'] = content
+  if (CACHE.sidebar && CACHE.sidebar === content) return
+  CACHE.sidebar = content
  renderTo('aside.sidebar', content)
  if (isToc) scrollActiveSidebar()
  toc = []
 }

+/**
+ * render loading bar
+ * @return {[type]} [description]
+ */
+export function renderLoading ({ loaded, total }) {
+  const num = Math.floor(loaded / total * 100)
+
+  if (!CACHE.loading) {
+    const div = document.createElement('div')
+
+    div.classList.add('progress')
+    document.body.appendChild(div)
+    CACHE.loading = div
+  }
+
+  CACHE.loading.style.opacity = 1
+  CACHE.loading.style.width = num >= 95 ? '100%' : num + '%'
+
+  if (num >= 95) {
+    clearTimeout(renderLoading.cacheTImeout)
+    renderLoading.cacheTImeout = setTimeout(_ => {
+      CACHE.loading.style.opacity = 0
+      CACHE.loading.style.width = '0%'
+    }, 200)
+  }
+}
+
+/**
+ * Load Config
+ * @param  {Object} options
+ */
 export function config (options) {
  OPTIONS = options
 }
+
@@ -8,6 +8,18 @@
  -webkit-font-smoothing: antialiased;
 }

+.progress {
+  background-color: $color-primary;
+  height: 2px;
+  left: 0px;
+  position: fixed;
+  right: 0px;
+  top: 0px;
+  transition: width 0.2s, opacity 0.4s;
+  width: 0%;
+  z-index: 999999;
+}
+
 html, body {
  height: 100%;
 }
@@ -223,6 +235,33 @@ main {
  }
 }

+.markdown-section table {
+  display: block;
+  width: 100%;
+  overflow: auto;
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+
+.markdown-section th {
+  font-weight: bold;
+  padding: 6px 13px;
+  border: 1px solid #ddd;
+}
+
+.markdown-section td {
+  padding: 6px 13px;
+  border: 1px solid #ddd;
+}
+
+.markdown-section tr {
+  background-color: #fff;
+  border-top: 1px solid #ccc;
+  &:nth-child(2n) {
+    background-color: #f8f8f8;
+  }
+}
+
 body.close {
  .sidebar {
    transform: translateX(-$sidebar-width);
@@ -234,11 +273,12 @@ body.close {
 }

@media (max-width: 600px) {
-  nav, .github-corner, .sidebar-toggle, .sidebar {
+  .github-corner, .sidebar-toggle, .sidebar {
    position: fixed;
  }

  nav {
+    position: static;
    margin-top: 16px;
  }

@@ -277,7 +277,7 @@ code .token {
 pre::after {
  color: #ccc;
  content: attr(data-lang);
-  font-size: 0.75em;
+  font-size: 0.6em;
  font-weight: 600;
  height: 15px;
  line-height: 15px;
@@ -57,3 +57,4 @@ export function tree (toc, tpl = '') {

  return tpl
 }
+
@@ -1,10 +1,11 @@
 /**
 * Simple ajax
 * @param  {String} url
- * @param  {String} [method=get]
+ * @param  {String} [method=GET]
+ * @param {Function} [loading] handle loading
 * @return {Promise}
 */
-export function load (url, method = 'get') {
+export function load (url, method = 'GET', loading) {
  const xhr = new XMLHttpRequest()

  xhr.open(method, url)
@@ -12,11 +13,16 @@ export function load (url, method = 'get') {

  return {
    then: function (success, error = function () {}) {
+      if (loading) {
+        xhr.addEventListener('progress', loading)
+        xhr.addEventListener('loaded', loading)
+      }
      xhr.addEventListener('error', error)
      xhr.addEventListener('load', ({ target }) => {
        target.status >= 400 ? error(target) : success(target.response)
      })
-    }
+    },
+    abort: () => xhr.readyState !== 4 && xhr.abort()
  }
 }

@@ -89,3 +95,8 @@ export function getRoute () {

  return route
 }
+
+export function isMobile () {
+  return document.body.clientWidth <= 600
+}
+
Author	SHA1	Message	Date
qingwei.li	ab34cc97f9	-> v1.1.5	2016-12-18 10:50:37 +08:00
qingwei.li	3fbcd876ae	bump 1.1.5	2016-12-18 10:50:02 +08:00
qingwei.li	3af5ca5cd4	Correct calculation of whether the mobile browser	2016-12-18 10:49:21 +08:00
qingwei.li	74ee0cf6bc	Add table style	2016-12-18 10:37:34 +08:00
qingwei.li	46dd542b48	-> v1.1.4	2016-12-17 16:08:45 +08:00
qingwei.li	cc7bdf5df2	bump 1.1.4	2016-12-17 15:56:55 +08:00
qingwei.li	9a1db6ed43	Fix chinese auchor link	2016-12-17 15:56:01 +08:00
qingwei.li	9d30ac7435	-> v1.1.3	2016-12-17 15:38:59 +08:00
qingwei.li	f8a68b87c7	bump 1.1.3	2016-12-17 15:38:00 +08:00
qingwei.li	7dc47cc4d4	Optimize progress bar again	2016-12-17 15:37:32 +08:00
qingwei.li	7d995d8362	Update readme	2016-12-17 15:25:03 +08:00
qingwei.li	1fdfaf0b6b	-> v1.1.2	2016-12-17 15:18:04 +08:00
qingwei.li	fe33e2d506	bump 1.1.2	2016-12-17 15:17:20 +08:00
qingwei.li	6463dd3bae	Optimize progress bar again	2016-12-17 15:14:52 +08:00
qingwei.li	299c31dff9	Fix auto2top in mobile	2016-12-17 15:08:44 +08:00
qingwei.li	aa1d84b513	1.1.1	2016-12-17 09:07:15 +08:00
qingwei.li	14a4c2f77d	bump 1.1.1	2016-12-17 09:01:41 +08:00
qingwei.li	e58c17fdc6	Optimize progress bar	2016-12-17 09:01:21 +08:00
qingwei.li	8b719238e6	-> v1.1.0	2016-12-16 22:38:53 +08:00
qingwei.li	7f0b1089c0	bump 1.1.0	2016-12-16 22:38:44 +08:00
cinwell.liandGitHub	2610e25040	Add progress bar and auto2top (#27 ) * Add progress bar * Add abort ajax * Remove console * Add cache folder * Add auto2top	2016-12-16 22:37:21 +08:00
cinwell.li	ec53f1e307	Add Beerpay's badge	2016-12-15 19:11:15 +08:00