-> v1.2.0

bump 1.2.0
Feat/1.2 (#33 )
2026-08-10 05:48:18 +10:00 · 2016-12-20 21:20:18 +08:00 · 2016-12-20 21:20:08 +08:00 · 2016-12-20 21:18:52 +08:00 · 2016-12-20 10:20:56 +08:00 · 2016-12-19 23:05:47 +08:00
24 changed files with 583 additions and 184 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 data-load-sidebar></script>
+<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-auto2top data-sidebar-toggle data-router></script>
 </html>
@@ -1,3 +1,59 @@
+## 1.2.0
+### Features
+- custom basePath
+- custom homepage
+
+## 1.1.7
+### Bug fixes
+- Optimize progress bar
+
+## 1.1.6
+### Features
+- Add logo 😂
+
+### Bug fixes
+- Remove table background color
+- Fixed highlight sidebar using chinese ids
+
+## 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
+
+## 1.0.2
+### Bug fixes
+- Fix binding events bug, fixed #24
+- Fix regular expression, fixed #23
+
 ## 1.0.1
 ### Bug fixes
 - `img` style
@@ -1,15 +1,25 @@
-# docsify
-[![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docsify)
-[![npm](https://img.shields.io/npm/v/docsify.svg)](https://www.npmjs.com/package/docsify)
+<p align="center">
+  <a href="https://docsify.js.org">
+    <img alt="docsify" src="./media/docsify.png">
+  </a>
+</p>

->🃏 A magical documentation site generator.
+<p align="center">
+  A magical documentation site generator.
+</p>
+
+<p align="center">
+  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/rust-lang/rust/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://beerpay.io/QingWei-Li/docsify"><img alt="npm" src="https://beerpay.io/QingWei-Li/docsify/badge.svg?style=beer-square"></a>
+</p>

 ## Links
 - [Documentation](https://docsify.js.org)
 - [CLI](https://github.com/QingWei-Li/docsify-cli)

 ## Features
- Easy and lightweight
+- Easy and lightweight (~12kb gzipped)
 - Custom themes
 - No build

@@ -25,7 +35,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,11 +53,17 @@ 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>
 ```

+## CDN
+- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
+- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
+
 ## Showcase
 These open-source projects are using docsify to generate their sites. Pull requests welcome : )

@@ -60,3 +78,4 @@ These open-source projects are using docsify to generate their sites. Pull reque

 ## License
 MIT
+
@@ -1,9 +1,13 @@
-# docsify
+<p align="center">
+  <img alt="docsify" src="https://cloud.githubusercontent.com/assets/7565692/21292094/5c206de4-c533-11e6-9493-29ea67b01dde.png">
+</p>

-> A magical documentation site generator.
+<p align="center">
+  A magical documentation site generator.
+</p>

 ## Features
- Easy and lightweight
+- Easy and lightweight (~12kb gzipped)
 - Custom themes
 - No build

@@ -98,6 +102,11 @@ Code in `404.html`
 </nav>
 ```

+
+### CDN
+- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
+- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
+
 ### Options

 #### repo
@@ -156,6 +165,7 @@ Custom sidebar. if it'set, the TOC will be disabeld. Bind global variables on th
 #### load-sidebar

 Load sidebar markdown file. If it is configured, load  the current directory `_sidebar.md` by default. If the file isn't exist, sidebar will appear TOC.
+** you should add `.nojekyll` into docs folder, to prevent GitHub Pages from ignoring the `_sidebar.md`**

 ```html
 <script src="/lib/docsify.js" data-load-sidebar></script>
@@ -213,10 +223,41 @@ If you write a sub level list, it will generate a dropdown list.
  - [chinese](/zh-cn)
 ```

-### router
+#### router

 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>
+```
+
+#### homepage
+
+`README.md` will be render as homepage for your website in docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. we can use:
+
+```html
+<script src="/lib/docsify.js" data-homepage="https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md"></script>
+<!-- Or using `Welcome.md` as homepge -->
+<script src="/lib/docsify.js" data-homepage="Welcome.md"></script>
+```
+
+
+#### basePath
+
+If your HTML entry file and the markdown files are in different directories, we can use:
+
+```html
+<script src="/lib/docsify.js" data-base-path="/base/"></script>
+
+<!-- Even if the docs is on another site 😄 -->
+<script src="/lib/docsify.js" data-base-path="https://docsify.js.org/"></script>
+```
@@ -3,6 +3,7 @@
 <head>
  <meta charset="UTF-8">
  <title>docsify - A magical documentation site generator.</title>
+  <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">
@@ -1,11 +1,15 @@
-# docsify
+<p align="center">
+  <img alt="docsify" src="https://cloud.githubusercontent.com/assets/7565692/21292094/5c206de4-c533-11e6-9493-29ea67b01dde.png">
+</p>

-> 无需构建快速生成文档页
+<p align="center">
+  无需构建快速生成文档页
+</p>

 ## 特性
 - 无需构建，写完 markdown 直接发布
 - 支持自定义主题
- 容易使用并且轻量
+- 容易使用并且轻量 (~12kb gzipped)

 ## 快速上手

@@ -97,9 +101,10 @@ docsify serve docs
 </nav>
 ```

-### CDN

-目前可用的 CDN 有 [UNPKG](unpkg.com/docsify)，如果觉得访问较慢可以将文件放到 Pages 的目录下。
+### CDN
+- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
+- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)

 ### 配置参数

@@ -157,6 +162,7 @@ Sidebar 开关按钮
 #### load-sidebar

 读取侧边栏配置文件，如果配置，默认加载当前目录下的 `_sidebar.md`。如果文件不存在，会显示 TOC 作为侧边栏内容。如果你有二级目录，也应该放置一份配置文件。
+**如果用 `_` 开头作为文件名，你应该在文档目录下添加 `.nojekyll`，阻止 GitHub Pages 忽略下划线开头的文件。**

 ```html
 <script src="/lib/docsify.js" data-load-sidebar></script>
@@ -214,10 +220,41 @@ Sidebar 开关按钮
 ```


-### router
+#### router

 开启 hash router 功能，此时可以创建 `index.html` 作为入口文件，同时多页面切换不会重新加载资源。资源路径会被替换成 `/#/` 的形式。

 ```html
 <script src="/lib/docsify.js" data-router></script>
 ```
+
+#### auto2top
+
+切换路由时自动跳转到页面顶部
+
+
+```html
+<script src="/lib/docsify.js" data-auto2top></script>
+```
+
+#### homepage
+
+默认情况下网站会将根目录下 `README.md` 作为首页渲染，但是有些时候我们想指定其他文件，甚至想直接将 repo 下的 README 作为首页。你可以这样做：
+
+
+```html
+<script src="/lib/docsify.js" data-homepage="https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md"></script>
+<!-- 或者将 Welcome.md 作为首页 -->
+<script src="/lib/docsify.js" data-homepage="Welcome.md"></script>
+```
+
+#### basePath
+
+指定加载文档的路径，如果你的 HTML 入口文件和文档是放在不同地方，你可以设置：
+
+```html
+<script src="/lib/docsify.js" data-base-path="/base/"></script>
+
+<!-- 甚至文档是在其他站点下 😄 -->
+<script src="/lib/docsify.js" data-base-path="https://docsify.js.org/"></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,23 @@ function load (url, method) {
    then: function (success, error) {
      if ( error === void 0 ) error = function () {};

+      if (loading) {
+        var id = setInterval(function (_) { return loading({ step: Math.floor(Math.random() * 5 + 1) }); },
+        500);
+        xhr.addEventListener('progress', loading);
+        xhr.addEventListener('loadend', function (evt) {
+          loading(evt);
+          clearInterval(id);
+        });
+      }
      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,6 +110,111 @@ function getRoute () {
  return route
 }

+function isMobile () {
+  return document.body.clientWidth <= 600
+}
+
+/**
+ * Active sidebar when scroll
+ * @link https://buble.surge.sh/
+ */
+function scrollActiveSidebar () {
+  if (isMobile()) { return }
+
+  var anchors = document.querySelectorAll('.anchor');
+  var nav = {};
+  var lis = document.querySelectorAll('.sidebar li');
+  var active = null;
+
+  for (var i = 0, len = lis.length; i < len; i += 1) {
+    var li = lis[i];
+    var href = li.querySelector('a').getAttribute('href');
+
+    if (href !== '/') { href = href.match(/#([^#]+)$/g)[0].slice(1); }
+
+    nav[decodeURIComponent(href)] = li;
+  }
+
+  function highlight () {
+    for (var i = 0, len = anchors.length; i < len; i += 1) {
+      var node = anchors[i].parentNode;
+      var bcr = node.getBoundingClientRect();
+
+      if (bcr.top < 10 && bcr.bottom > 10) {
+        var li = nav[node.id];
+
+        if (!li || li === active) { return }
+        if (active) { active.setAttribute('class', ''); }
+
+        li.setAttribute('class', 'active');
+        active = li;
+
+        return
+      }
+    }
+  }
+
+  var dom = document.querySelector('main .content');
+  dom.removeEventListener('scroll', highlight);
+  dom.addEventListener('scroll', highlight);
+  highlight();
+}
+
+function scrollIntoView () {
+  var id = window.location.hash.match(/#[^#\/]+$/g);
+  if (!id || !id.length) { return }
+  var section = document.querySelector(decodeURIComponent(id[0]));
+
+  if (section) { section.scrollIntoView(); }
+}
+
+/**
+ * Acitve link
+ */
+function activeLink (dom, activeParent) {
+  var host = window.location.href;
+
+  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
+  if (!dom) { return
+
+  ; }[].slice.call(dom.querySelectorAll('a')).forEach(function (node) {
+    if (node.href === host) {
+      activeParent
+        ? node.parentNode.setAttribute('class', 'active')
+        : node.setAttribute('class', 'active');
+    } else {
+      activeParent
+        ? node.parentNode.removeAttribute('class')
+        : node.removeAttribute('class');
+    }
+  });
+}
+
+/**
+ * sidebar toggle
+ */
+function bindToggle (dom) {
+  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
+  if (!dom) { return }
+  var body = document.body;
+
+  dom.addEventListener('click', function () { return body.classList.toggle('close'); });
+
+  if (!/mobile/i.test(navigator.userAgent)) { return }
+  document.querySelector('aside').addEventListener('click', function (event) {
+    body.classList.toggle('close');
+  });
+}
+
+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 : {};


@@ -2240,100 +2356,8 @@ function tree (toc, tpl) {
  return tpl
 }

-/**
- * Active sidebar when scroll
- * @link https://buble.surge.sh/
- */
-function scrollActiveSidebar () {
-  if (/mobile/i.test(navigator.userAgent)) { return }
-
-  var anchors = document.querySelectorAll('.anchor');
-  var nav = {};
-  var lis = document.querySelectorAll('.sidebar li');
-  var active = null;
-
-  for (var i = 0, len = lis.length; i < len; i += 1) {
-    var li = lis[i];
-    var href = li.querySelector('a').getAttribute('href');
-
-    if (href !== '/') { href = href.match(/#([^#]+)$/g)[0].slice(1); }
-
-    nav[href] = li;
-  }
-
-  function highlight () {
-    for (var i = 0, len = anchors.length; i < len; i += 1) {
-      var node = anchors[i].parentNode;
-      var bcr = node.getBoundingClientRect();
-
-      if (bcr.top < 10 && bcr.bottom > 10) {
-        var li = nav[node.id];
-
-        if (!li || li === active) { return }
-        if (active) { active.setAttribute('class', ''); }
-
-        li.setAttribute('class', 'active');
-        active = li;
-
-        return
-      }
-    }
-  }
-
-  document.querySelector('main .content').addEventListener('scroll', highlight);
-  highlight();
-
-  function scrollIntoView () {
-    var id = window.location.hash.match(/#[^#\/]+$/g);
-    if (!id || !id.length) { return }
-    var section = document.querySelector(id[0]);
-
-    if (section) { section.scrollIntoView(); }
-  }
-
-  window.addEventListener('hashchange', scrollIntoView);
-  scrollIntoView();
-}
-
-/**
- * Acitve link
- */
-function activeLink (dom, activeParent) {
-  var host = window.location.href;
-
-  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
-  if (!dom) { return
-
-  ; }[].slice.call(dom.querySelectorAll('a')).forEach(function (node) {
-    if (node.href === host) {
-      activeParent
-        ? node.parentNode.setAttribute('class', 'active')
-        : node.setAttribute('class', 'active');
-    } else {
-      activeParent
-        ? node.parentNode.removeAttribute('class')
-        : node.removeAttribute('class');
-    }
-  });
-}
-
-/**
- * sidebar toggle
- */
-function bindToggle (dom) {
-  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
-  if (!dom) { return }
-  var body = document.body;
-
-  dom.addEventListener('click', function () { return body.classList.toggle('close'); });
-
-  if (!/mobile/i.test(navigator.userAgent)) { return }
-  document.querySelector('aside').addEventListener('click', function (event) {
-    body.classList.toggle('close');
-  });
-}
-
 var OPTIONS$1 = {};
+var CACHE = {};

 var renderTo = function (dom, content) {
  dom = typeof dom === 'object' ? dom : document.querySelector(dom);
@@ -2349,14 +2373,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,12 +2425,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;
  renderNavbar.rendered = true;

  if (content) { renderTo('nav', marked(content)); }
@@ -2415,8 +2445,6 @@ function renderNavbar (content) {
 * sidebar
 */
 function renderSidebar (content) {
-  renderSidebar.rendered = true;
-
  var isToc = false;

  if (content) {
@@ -2428,11 +2456,55 @@ function renderSidebar (content) {
    isToc = true;
  }

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

+/**
+ * render loading bar
+ * @return {[type]} [description]
+ */
+function renderLoading (ref) {
+  var loaded = ref.loaded;
+  var total = ref.total;
+  var step = ref.step;
+
+  var num;
+
+  if (!CACHE.loading) {
+    var div = document.createElement('div');
+
+    div.classList.add('progress');
+    document.body.appendChild(div);
+    CACHE.loading = div;
+  }
+  if (step) {
+    num = parseInt(CACHE.loading.style.width, 10) + step;
+    num = num > 80 ? 80 : num;
+  } else {
+    num = Math.floor(loaded / total * 100);
+  }
+
+  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;
 }
@@ -2445,7 +2517,10 @@ var OPTIONS = {
  sidebarToggle: false,
  loadSidebar: null,
  loadNavbar: null,
-  router: false
+  router: false,
+  homepage: 'README.md',
+  basePath: '',
+  auto2top: false
 };
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();

@@ -2464,26 +2539,50 @@ if (script) {
 config(OPTIONS);

 var cacheRoute = null;
+var cacheXhr = null;

-var mainRender = function () {
-  var route = getRoute();
-  if (cacheRoute === route) { return }
+var mainRender = function (cb) {
+  var route = OPTIONS.basePath + getRoute();
+  if (cacheRoute === route) { return cb() }

+  var wait;
  var basePath = cacheRoute = route;

  if (!/\//.test(basePath)) {
    basePath = '';
  } else if (basePath && !/\/$/.test(basePath)) {
-    basePath = basePath.match(/(\S+\/)[^\/]+$/)[1];
+    basePath = basePath.match(/(\S*\/)[^\/]+$/)[1];
  }

+  var page;
+  if (!route) {
+    page = OPTIONS.homepage || 'README.md';
+  } else if (/\/$/.test(route)) {
+    page = route + "README.md";
+  } else {
+    page = route + ".md";
+  }
+
+  cacheXhr && cacheXhr.abort && cacheXhr.abort();
  // Render markdown file
-  load((!route || /\/$/.test(route)) ? (route + "README.md") : (route + ".md"))
-    .then(renderArticle, function (_) { return renderArticle(null); });
+  cacheXhr = load(page, '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) {
-    load(basePath + OPTIONS.loadSidebar).then(renderSidebar);
+    load(basePath + OPTIONS.loadSidebar).then(function (result) {
+      renderSidebar(result);
+      if (wait === false) { cb(); }
+      wait = false;
+    });
  }

  // Render navbar
@@ -2495,13 +2594,19 @@ var mainRender = function () {
 var Docsify = function () {
  var dom = document.querySelector(OPTIONS.el) || document.body;
  var replace = dom !== document.body;
+  var main = function () {
+    mainRender(function (_) {
+      activeLink('aside.sidebar', true);
+      scrollIntoView();
+    });
+  };

  // Render app
  renderApp(dom, replace);
-  mainRender();
+  main();
  if (OPTIONS.router) {
    if (!/^#\//.test(window.location.hash)) { window.location.hash = '#/'; }
-    window.addEventListener('hashchange', mainRender);
+    window.addEventListener('hashchange', main);
  }
 };

@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "1.0.1",
+  "version": "1.2.0",
  "description": "A magical documentation generator.",
  "main": "lib/docsify.js",
  "files": [
@@ -10,7 +10,7 @@
  ],
  "scripts": {
    "build": "rm -rf lib themes && node build/build.js && mkdir lib/themes && mkdir themes && node build/build-css.js",
-    "dev": "node app.js & nodemon -w src --exec 'npm run build'",
+    "dev": "node app.js & nodemon -w src -e js,css --exec 'npm run build'",
    "test": "eslint src test"
  },
  "repository": {
@@ -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 = {}
@@ -17,7 +18,7 @@ export function scrollActiveSidebar () {

    if (href !== '/') href = href.match(/#([^#]+)$/g)[0].slice(1)

-    nav[href] = li
+    nav[decodeURIComponent(href)] = li
  }

  function highlight () {
@@ -39,19 +40,18 @@ export function scrollActiveSidebar () {
    }
  }

-  document.querySelector('main .content').addEventListener('scroll', highlight)
+  const dom = document.querySelector('main .content')
+  dom.removeEventListener('scroll', highlight)
+  dom.addEventListener('scroll', highlight)
  highlight()
+}

-  function scrollIntoView () {
-    const id = window.location.hash.match(/#[^#\/]+$/g)
-    if (!id || !id.length) return
-    const section = document.querySelector(id[0])
+export function scrollIntoView () {
+  const id = window.location.hash.match(/#[^#\/]+$/g)
+  if (!id || !id.length) return
+  const section = document.querySelector(decodeURIComponent(id[0]))

-    if (section) section.scrollIntoView()
-  }
-
-  window.addEventListener('hashchange', scrollIntoView)
-  scrollIntoView()
+  if (section) section.scrollIntoView()
 }

 /**
@@ -91,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
+}
@@ -1,4 +1,5 @@
 import { load, camel2kebab, isNil, getRoute } from './util'
+import { activeLink, scrollIntoView } from './event'
 import * as render from './render'

 const OPTIONS = {
@@ -9,7 +10,10 @@ const OPTIONS = {
  sidebarToggle: false,
  loadSidebar: null,
  loadNavbar: null,
-  router: false
+  router: false,
+  homepage: 'README.md',
+  basePath: '',
+  auto2top: false
 }
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()

@@ -28,26 +32,50 @@ if (script) {
 render.config(OPTIONS)

 let cacheRoute = null
+let cacheXhr = null

-const mainRender = function () {
-  const route = getRoute()
-  if (cacheRoute === route) return
+const mainRender = function (cb) {
+  const route = OPTIONS.basePath + getRoute()
+  if (cacheRoute === route) return cb()

+  let wait
  let basePath = cacheRoute = route

  if (!/\//.test(basePath)) {
    basePath = ''
  } else if (basePath && !/\/$/.test(basePath)) {
-    basePath = basePath.match(/(\S+\/)[^\/]+$/)[1]
+    basePath = basePath.match(/(\S*\/)[^\/]+$/)[1]
  }

+  let page
+  if (!route) {
+    page = OPTIONS.homepage || 'README.md'
+  } else if (/\/$/.test(route)) {
+    page = `${route}README.md`
+  } else {
+    page = `${route}.md`
+  }
+
+  cacheXhr && cacheXhr.abort && cacheXhr.abort()
  // Render markdown file
-  load((!route || /\/$/.test(route)) ? `${route}README.md` : `${route}.md`)
-    .then(render.renderArticle, _ => render.renderArticle(null))
+  cacheXhr = load(page, '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) {
-    load(basePath + OPTIONS.loadSidebar).then(render.renderSidebar)
+    load(basePath + OPTIONS.loadSidebar).then(result => {
+      render.renderSidebar(result)
+      if (wait === false) cb()
+      wait = false
+    })
  }

  // Render navbar
@@ -59,13 +87,19 @@ const mainRender = function () {
 const Docsify = function () {
  const dom = document.querySelector(OPTIONS.el) || document.body
  const replace = dom !== document.body
+  const main = function () {
+    mainRender(_ => {
+      activeLink('aside.sidebar', true)
+      scrollIntoView()
+    })
+  }

  // Render app
  render.renderApp(dom, replace)
-  mainRender()
+  main()
  if (OPTIONS.router) {
    if (!/^#\//.test(window.location.hash)) window.location.hash = '#/'
-    window.addEventListener('hashchange', mainRender)
+    window.addEventListener('hashchange', main)
  }
 }

@@ -1,10 +1,11 @@
 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 = {}
+const CACHE = {}

 const renderTo = function (dom, content) {
  dom = typeof dom === 'object' ? dom : document.querySelector(dom)
@@ -20,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}>`
 }
@@ -68,12 +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
  renderNavbar.rendered = true

  if (content) renderTo('nav', marked(content))
@@ -84,8 +91,6 @@ export function renderNavbar (content) {
 * sidebar
 */
 export function renderSidebar (content) {
-  renderSidebar.rendered = true
-
  let isToc = false

  if (content) {
@@ -97,11 +102,52 @@ export function renderSidebar (content) {
    isToc = true
  }

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

+/**
+ * render loading bar
+ * @return {[type]} [description]
+ */
+export function renderLoading ({ loaded, total, step }) {
+  let num
+
+  if (!CACHE.loading) {
+    const div = document.createElement('div')
+
+    div.classList.add('progress')
+    document.body.appendChild(div)
+    CACHE.loading = div
+  }
+  if (step) {
+    num = parseInt(CACHE.loading.style.width, 10) + step
+    num = num > 80 ? 80 : num
+  } else {
+    num = Math.floor(loaded / total * 100)
+  }
+
+  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;
+  margin-bottom: 1em;
+}
+
+.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 {
+  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;
  }

@@ -54,6 +54,8 @@ body {
 .markdown-section ul,
 .markdown-section ol {
  word-spacing: 0.05em;
+  line-height: 1.6em;
+  margin: 0 0 1em 0;
 }

 .markdown-section h1 {
@@ -95,13 +97,6 @@ body {
  margin: 1.2em 0;
 }

-.markdown-section p,
-.markdown-section ul,
-.markdown-section ol {
-  margin: 0 0 1em 0;
-  line-height: 1.5;
-}
-
 .markdown-section ul,
 .markdown-section ol {
  padding-left: 1.5em;
@@ -36,7 +36,7 @@ body {

  ul li.active>a {
    color: $color-primary;
-    font-weight: 500;
+    font-weight: 600;
  }
 }

@@ -55,12 +55,6 @@ body {
  font-weight: 600;
 }

-.markdown-section p,
-.markdown-section ul,
-.markdown-section ol {
-  word-spacing: 0.05em;
-}
-
 .markdown-section h1 {
  margin: 0 0 1em;
  font-size: 2em;
@@ -100,6 +94,7 @@ body {
 .markdown-section ul,
 .markdown-section ol {
  line-height: 1.6em;
+  word-spacing: 0.05em;
 }

 .markdown-section ul,
@@ -277,7 +272,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,22 @@ export function load (url, method = 'get') {

  return {
    then: function (success, error = function () {}) {
+      if (loading) {
+        const id = setInterval(_ =>
+          loading({ step: Math.floor(Math.random() * 5 + 1) }),
+        500)
+        xhr.addEventListener('progress', loading)
+        xhr.addEventListener('loadend', evt => {
+          loading(evt)
+          clearInterval(id)
+        })
+      }
      xhr.addEventListener('error', error)
      xhr.addEventListener('load', ({ target }) => {
        target.status >= 400 ? error(target) : success(target.response)
      })
-    }
+    },
+    abort: () => xhr.readyState !== 4 && xhr.abort()
  }
 }

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

  return route
 }
+
+export function isMobile () {
+  return document.body.clientWidth <= 600
+}
+
Author	SHA1	Message	Date
qingwei.li	476d49bc1f	-> v1.2.0	2016-12-20 21:20:18 +08:00
qingwei.li	73456e6fac	bump 1.2.0	2016-12-20 21:20:08 +08:00
cinwell.liandGitHub	f9d75ab931	Feat/1.2 (#33 ) * Add homepage option, fixed #30 * Add custom basePath support, resolve #31	2016-12-20 21:18:52 +08:00
qingwei.li	f93f9ceb09	Add cdn	2016-12-20 10:20:56 +08:00
qingwei.li	b57712dd5a	Add .nojekyll	2016-12-19 23:05:47 +08:00
qingwei.li	f2d894932b	-> v1.1.7	2016-12-19 21:53:42 +08:00
qingwei.li	48912a0b79	bump 1.1.7	2016-12-19 21:53:25 +08:00
qingwei.li	73a193d602	Optimize progress bar	2016-12-19 21:52:33 +08:00
qingwei.li	30b6644f21	fix typo	2016-12-19 20:38:35 +08:00
qingwei.li	d343ff5b21	Update badges	2016-12-18 19:43:58 +08:00
qingwei.li	3bf932a81c	-> v1.1.6	2016-12-18 15:37:57 +08:00
qingwei.li	c8bb66955d	bump 1.1.6	2016-12-18 15:37:47 +08:00
qingwei.li	e5e1e07e1a	Fixed highlight sidebar using chinese ids	2016-12-18 15:37:24 +08:00
cinwell.liandGitHub	9ba989c86c	Add logo (#28 ) * Fix table style * Add logo * Update index.html * Update doc	2016-12-18 15:30:50 +08:00
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
qingwei.li	670cc68a28	-> v1.0.3	2016-12-13 22:27:36 +08:00
qingwei.li	844ba3e022	bump 1.0.3	2016-12-13 22:27:26 +08:00
qingwei.li	9092b22246	Fix cache sidebar content	2016-12-13 22:26:56 +08:00
qingwei.li	d175ba6913	-> v1.0.2	2016-12-13 22:12:18 +08:00
qingwei.li	2574778605	bump 1.0.2	2016-12-13 22:11:50 +08:00
cinwell.liandGitHub	44a255103c	Fix/1.0.2 (#25 ) * Fix regular expression, fixed #23 * Fix repeat binding events * Add content cache * Add changelog	2016-12-13 22:10:58 +08:00