-> v1.3.2

bump 1.3.2
Fixed render link
2026-08-09 21:36:10 +10:00 · 2016-12-23 01:20:57 +08:00 · 2016-12-23 01:20:47 +08:00 · 2016-12-23 01:20:28 +08:00 · 2016-12-23 00:25:05 +08:00 · 2016-12-23 00:24:45 +08:00
26 changed files with 629 additions and 140 deletions
@@ -1,3 +1,4 @@
+.DS_Store
 *.log
 node_modules
 yarn.lock
@@ -1,3 +1,52 @@
+## 1.3.2
+
+### Bug fixes
+- Fixed render link
+
+## 1.3.1
+
+### Bug fixes
+- Fixed cover page style
+- Generate the correct link when rendering the article
+
+## 1.3.0
+### Features
+- Add cover page
+- add `<kbd>` style
+- headling can be cliked
+
+### Bug fixes
+- sidebar highlight
+
+
+### break change
+- Navbar no longer fixed at the top
+
+## 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,38 +1,30 @@
-# 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://github.com/vuejs/vue"><img alt="code style" src="https://img.shields.io/badge/code%20style-vue-orange.svg?style=flat-square"></a>
+</p>

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

 ## Features
- Easy and lightweight
- Custom themes
- No build
+- Simple and lightweight (~12kb gzipped)
+- Multiple themes
+- Not build static html files

 ## Quick start
-Create a `404.html` and `README.md` into `/docs`.
-
-404.html
-
-```html
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="UTF-8">
-  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-</body>
-<script src="//unpkg.com/docsify"></script>
-</html>
-```
-
-Or Create a `index.html` and using `hash router`.
+Create a `index.html` and using `hash router`.

 index.html

@@ -50,22 +42,38 @@ index.html
 </html>
 ```

+Or create a `404.html` and `README.md` into `/docs`. Just remove `data-router`
+
+```html
+<script src="//unpkg.com/docsify"></script>
+```
+
+## 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 : )

 - [docsify](https://docsify.js.org) - A magical documentation site generator.
 - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.

-## How to contribute
+## Contributing

 - Fork it!
- Run `npm i && npm run dev`
- open `localhost:3000`
+- Create your feature branch: `git checkout -b my-new-feature`
+- Commit your changes: `git commit -am 'Add some feature'`
+- Push to the branch: `git push origin my-new-feature`
+- Submit a pull request :D
+
+
+## Development
+
+```shell
+npm i && npm run dev
+open http://localhost:3000
+```

 ## 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)
@@ -1,12 +1,3 @@
-# docsify
-
-> A magical documentation site generator.
-
-## Features
- Easy and lightweight
- Custom themes
- No build
-
 ## Quick Start

 ### Create a project
@@ -98,6 +89,33 @@ 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)
+
+
+### Cover Page
+
+Through the markdown can generate a cover page. create a `_coverpage.md` and set `data-coverpage` in script tag.
+
+```markdown
+![logo](_media/icon.svg)
+
+# docsify <small>1.2.0</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~12kb gzipped)
+- Multiple themes
+- Not build static html files
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+```
+
+
 ### Options

 #### repo
@@ -156,6 +174,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,7 +232,7 @@ 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`.

@@ -221,7 +240,7 @@ Hash router. You can replace `404.html` with `index.html`.
 <script src="/lib/docsify.js" data-router></script>
 ```

-### auto2top
+#### auto2top

 Scroll to the top on changing hash.

@@ -230,3 +249,35 @@ Scroll to the top on changing hash.
 <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 (need `data-router`):
+
+```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>
+```
+
+
+#### coverpage
+
+Generate cover page.
+
+```html
+<script src="/lib/docsify.js" data-coverpage></script>
+<!-- or -->
+<script src="/lib/docsify.js" data-coverpage="other.md"></script>
+```
@@ -0,0 +1,13 @@
+![logo](_media/icon.svg)
+
+# docsify <small>1.3.2</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~12kb gzipped)
+- Multiple themes
+- Not build static html files
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="122px" height="94px" viewBox="0 0 122 94" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 41.2 (35397) - http://www.bohemiancoding.com/sketch -->
+    <title>icon</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <path d="M144.453286,104 C177.038086,104 203.453286,77.5848002 203.453286,45 C203.453286,12.4151998 177.038086,-14 144.453286,-14 C111.868486,-14 114.603207,13.6754846 114.603207,46.2602848 C114.603207,78.845085 111.868486,104 144.453286,104 Z" id="path-1"></path>
+        <filter x="-50%" y="-50%" width="200%" height="200%" filterUnits="objectBoundingBox" id="filter-2">
+            <feOffset dx="7" dy="-10" in="SourceAlpha" result="shadowOffsetInner1"></feOffset>
+            <feComposite in="shadowOffsetInner1" in2="SourceAlpha" operator="arithmetic" k2="-1" k3="1" result="shadowInnerInner1"></feComposite>
+            <feColorMatrix values="0 0 0 0 0   0 0 0 0 0   0 0 0 0 0  0 0 0 0.1 0" type="matrix" in="shadowInnerInner1"></feColorMatrix>
+        </filter>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="icon" transform="translate(-98.000000, 2.000000)">
+            <g id="body" transform="translate(159.000000, 45.000000) rotate(-90.000000) translate(-159.000000, -45.000000) ">
+                <use fill="#2ECE53" fill-rule="evenodd" xlink:href="#path-1"></use>
+                <use fill="black" fill-opacity="1" filter="url(#filter-2)" xlink:href="#path-1"></use>
+                <use stroke="#0E1320" stroke-width="4" xlink:href="#path-1"></use>
+            </g>
+            <circle id="left-eye" fill="#000000" cx="139" cy="38" r="7"></circle>
+            <circle id="right-eye" fill="#000000" cx="183" cy="38" r="7"></circle>
+            <g id="light" transform="translate(112.000000, 10.000000)" fill="#FFFFFF">
+                <circle cx="2" cy="28" r="2"></circle>
+                <path d="M12.2551528,-1.65016666 C12.1154537,-2.17684986 12.4455583,-2.60381096 13.011574,-2.60381096 L14.9928363,-2.60381096 C15.5502953,-2.60381096 16.1214654,-2.16566487 16.2594657,-1.64268776 C16.2594657,-1.64268776 17.4280152,2.48668594 17.9030739,6.45786647 C18.3781327,10.429047 18.3171359,10.4652901 18.3171359,12.1782569 C18.3171359,16.9413523 16.2076398,26.4389164 16.2076398,26.4389164 C16.0941814,26.9676035 15.558852,27.396189 14.9928363,27.396189 L13.011574,27.396189 C12.454115,27.396189 12.1166642,26.9691757 12.2568366,26.4301177 C12.2568366,26.4301177 13.4260575,22.2288768 13.9640759,17.9859148 C14.5020943,13.7429529 14.309594,15.2982629 14.5626609,12.3723978 C14.9355337,8.06138047 12.2551528,-1.65016666 12.2551528,-1.65016666 Z" id="light-line" transform="translate(15.271433, 12.396189) scale(-1, 1) rotate(-48.000000) translate(-15.271433, -12.396189) "></path>
+            </g>
+            <path d="M159.5,78.3050108 C169.164983,78.3050108 177,70.4699939 177,60.8050108 C177,51.1400277 169.688728,56.4616841 160.023745,56.4616841 C150.358762,56.4616841 142,51.1400277 142,60.8050108 C142,70.4699939 149.835017,78.3050108 159.5,78.3050108 Z" id="mouth" fill="#000000"></path>
+        </g>
+    </g>
+</svg>
@@ -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">
@@ -16,8 +17,8 @@
 </body>
 <script
  src="//unpkg.com/docsify/lib/docsify.min.js"
-  data-repo="qingwei-li/docsify"
-  data-max-level="3"
+  data-max-level="4"
  data-sidebar-toggle
+  data-coverpage
  data-router></script>
 </html>
@@ -1,11 +1,8 @@
-# docsify
-
-> 无需构建快速生成文档页

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

 ## 快速上手

@@ -97,9 +94,32 @@ 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)
+
+### 封面
+
+只需要写几行简单的 markdown 就可以拥有一页精致的封面，通过添加 `data-coverpage` 属性，并创建 `_coverpage.md`，按照下面的格式书写即可。
+
+```markdown
+![logo](_media/icon.svg)
+
+# docsify <small>1.2.0</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~12kb gzipped)
+- Multiple themes
+- Not build static html files
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+```
+
+

 ### 配置参数

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

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

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


-### router
+#### router

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

@@ -222,7 +243,7 @@ Sidebar 开关按钮
 <script src="/lib/docsify.js" data-router></script>
 ```

-### auto2top
+#### auto2top

 切换路由时自动跳转到页面顶部

@@ -231,3 +252,35 @@ Sidebar 开关按钮
 <script src="/lib/docsify.js" data-auto2top></script>
 ```

+#### homepage
+
+默认情况下网站会将根目录下 `README.md` 作为首页渲染，但是有些时候我们想指定其他文件，甚至想直接将 repo 下的 README 作为首页。你可以这样做（需要设置 `data-router`）：
+
+
+```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>
+```
+
+#### coverpage
+
+生成封面，参考 [#封面](#封面).
+
+```html
+<script src="/lib/docsify.js" data-coverpage></script>
+<!-- or -->
+<script src="/lib/docsify.js" data-coverpage="other.md"></script>
+
+```
@@ -21,8 +21,13 @@ function load (url, method, loading) {
      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('loaded', loading);
+        xhr.addEventListener('loadend', function (evt) {
+          loading(evt);
+          clearInterval(id);
+        });
      }
      xhr.addEventListener('error', error);
      xhr.addEventListener('load', function (ref) {
@@ -106,7 +111,7 @@ function getRoute () {
 }

 function isMobile () {
-  return /mobile/i.test(navigator.userAgent)
+  return document.body.clientWidth <= 600
 }

 /**
@@ -127,16 +132,16 @@ function scrollActiveSidebar () {

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

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

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

      if (bcr.top < 10 && bcr.bottom > 10) {
-        var li = nav[node.id];
+        var li = nav[node.getAttribute('data-id')];

        if (!li || li === active) { return }
        if (active) { active.setAttribute('class', ''); }
@@ -149,9 +154,8 @@ function scrollActiveSidebar () {
    }
  }

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

@@ -210,6 +214,19 @@ function scroll2Top () {
  cacheContentDOM.scrollTop = 0;
 }

+function sticky () {
+  var dom = document.querySelector('section.cover');
+  var coverHeight = dom.getBoundingClientRect().height;
+
+  return (function () {
+    if (window.pageYOffset >= coverHeight || dom.classList.contains('hidden')) {
+      document.body.classList.add('sticky');
+    } else {
+      document.body.classList.remove('sticky');
+    }
+  })()
+}
+
 var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};


@@ -2319,14 +2336,22 @@ function corner (data) {

 /**
 * Render main content
- * @return {[type]}      [description]
 */
-function main () {
-  return "<main>\n    <aside class=\"sidebar\"></aside>\n    <section class=\"content\">\n      <article class=\"markdown-section\"></article>\n    </section>\n  </main>"
+function main (tpl) {
+  return ("<main>\n    " + tpl + "\n    <aside class=\"sidebar\"></aside>\n    <section class=\"content\">\n      <article class=\"markdown-section\"></article>\n    </section>\n  </main>")
 }

-function toggle (bool) {
-  if (!bool) { return '' }
+/**
+ * Cover Page
+ */
+function cover () {
+  var SL = ', 100%, 85%';
+  var bgc = "linear-gradient(to left bottom, hsl(" + (Math.floor(Math.random() * 255) + SL) + ") 0%, hsl(" + (Math.floor(Math.random() * 255) + SL) + ") 100%)";
+
+  return ("<section class=\"cover\" style=\"background: " + bgc + "\">\n    <div class=\"cover-main\"></div>\n  </section>")
+}
+
+function toggle () {
  return "<button class=\"sidebar-toggle\">\n    <span></span><span></span><span></span>\n  </button>"
 }

@@ -2379,7 +2404,7 @@ renderer.heading = function (text, level) {

  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 + ">")
+  return ("<a href=\"" + route + "#" + slug + "\" data-id=\"" + slug + "\" class=\"anchor\"><h" + level + " id=\"" + slug + "\">" + text + "</h" + level + "></a>")
 };
 // highlight code
 renderer.code = function (code, lang) {
@@ -2391,7 +2416,7 @@ renderer.code = function (code, lang) {
 };
 renderer.link = function (href, title, text) {
  if (OPTIONS$1.router && !/^(?:\w+:)?\/\/([^\s\.]+\.\S{2}|localhost[\:?\d]*)\S*$/.test(href)) {
-    href = !/^\/#/.test(href) ? ("#" + href) : href;
+    href = ("#/" + href).replace(/\/\//g, '/');
  }

  return ("<a href=\"" + href + "\" title=\"" + (title || '') + "\">" + text + "</a>")
@@ -2404,11 +2429,21 @@ marked.setOptions({ renderer: renderer });
 function renderApp (dom, replace) {
  var nav = document.querySelector('nav') || document.createElement('nav');

-  dom[replace ? 'outerHTML' : 'innerHTML'] = toggle(OPTIONS$1.sidebarToggle) + corner(OPTIONS$1.repo) + main();
+  if (!OPTIONS$1.repo) { nav.classList.add('no-badge'); }
+
+  dom[replace ? 'outerHTML' : 'innerHTML'] = corner(OPTIONS$1.repo) +
+    (OPTIONS$1.coverpage ? cover() : '') +
+    main(OPTIONS$1.sidebarToggle ? toggle() : '');
  document.body.insertBefore(nav, document.body.children[0]);

  // bind toggle
  bindToggle('button.sidebar-toggle');
+  // bind sticky effect
+  if (OPTIONS$1.coverpage) {
+    !isMobile() && window.addEventListener('scroll', sticky);
+  } else {
+    document.body.classList.add('sticky');
+  }
 }

 /**
@@ -2459,6 +2494,20 @@ function renderSidebar (content) {
  toc = [];
 }

+/**
+ * Cover Page
+ */
+function renderCover (content) {
+  renderCover.dom = renderCover.dom || document.querySelector('section.cover');
+  if (!content) {
+    renderCover.dom.classList.add('hidden');
+  } else {
+    renderCover.dom.classList.remove('hidden');
+    !renderCover.rendered && renderTo('.cover-main', marked(content));
+    renderCover.rendered = true;
+  }
+}
+
 /**
 * render loading bar
 * @return {[type]} [description]
@@ -2466,8 +2515,9 @@ function renderSidebar (content) {
 function renderLoading (ref) {
  var loaded = ref.loaded;
  var total = ref.total;
+  var step = ref.step;

-  var num = Math.floor(loaded / total * 100);
+  var num;

  if (!CACHE.loading) {
    var div = document.createElement('div');
@@ -2476,13 +2526,19 @@ function renderLoading (ref) {
    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 (_) {
+    clearTimeout(renderLoading.cacheTimeout);
+    renderLoading.cacheTimeout = setTimeout(function (_) {
      CACHE.loading.style.opacity = 0;
      CACHE.loading.style.width = '0%';
    }, 200);
@@ -2506,6 +2562,9 @@ var OPTIONS = {
  loadSidebar: null,
  loadNavbar: null,
  router: false,
+  homepage: 'README.md',
+  coverpage: '',
+  basePath: '',
  auto2top: false
 };
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();
@@ -2518,6 +2577,7 @@ 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.sidebar) { OPTIONS.sidebar = window[OPTIONS.sidebar]; }
 }

@@ -2528,8 +2588,9 @@ var cacheRoute = null;
 var cacheXhr = null;

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

@@ -2539,13 +2600,27 @@ var mainRender = function (cb) {
    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";
+  }
+
+  // Render Cover page
+  if (OPTIONS.coverpage) {
+    if (page === OPTIONS.homepage) {
+      load(OPTIONS.coverpage).then(renderCover);
+    } else {
+      renderCover();
+    }
+  }
+
  cacheXhr && cacheXhr.abort && cacheXhr.abort();
  // Render markdown file
-  cacheXhr = load(
-    (!route || /\/$/.test(route)) ? (route + "README.md") : (route + ".md"),
-    'GET',
-    renderLoading);
-
+  cacheXhr = load(page, 'GET', renderLoading);
  cacheXhr.then(function (result) {
    renderArticle(result);
    if (OPTIONS.loadSidebar) {
@@ -2578,6 +2653,7 @@ var Docsify = function () {
    mainRender(function (_) {
      activeLink('aside.sidebar', true);
      scrollIntoView();
+      OPTIONS.coverpage && sticky();
    });
  };

@@ -1,6 +1,6 @@
 {
  "name": "docsify",
-  "version": "1.1.4",
+  "version": "1.3.2",
  "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": {
@@ -18,16 +18,16 @@ export function scrollActiveSidebar () {

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

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

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

      if (bcr.top < 10 && bcr.bottom > 10) {
-        const li = nav[node.id]
+        const li = nav[node.getAttribute('data-id')]

        if (!li || li === active) return
        if (active) active.setAttribute('class', '')
@@ -40,9 +40,8 @@ export function scrollActiveSidebar () {
    }
  }

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

@@ -100,3 +99,16 @@ export function scroll2Top () {
  }
  cacheContentDOM.scrollTop = 0
 }
+
+export function sticky () {
+  const dom = document.querySelector('section.cover')
+  const coverHeight = dom.getBoundingClientRect().height
+
+  return (function () {
+    if (window.pageYOffset >= coverHeight || dom.classList.contains('hidden')) {
+      document.body.classList.add('sticky')
+    } else {
+      document.body.classList.remove('sticky')
+    }
+  })()
+}
@@ -1,5 +1,5 @@
 import { load, camel2kebab, isNil, getRoute } from './util'
-import { activeLink, scrollIntoView } from './event'
+import { activeLink, scrollIntoView, sticky } from './event'
 import * as render from './render'

 const OPTIONS = {
@@ -11,6 +11,9 @@ const OPTIONS = {
  loadSidebar: null,
  loadNavbar: null,
  router: false,
+  homepage: 'README.md',
+  coverpage: '',
+  basePath: '',
  auto2top: false
 }
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()
@@ -23,6 +26,7 @@ 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.sidebar) OPTIONS.sidebar = window[OPTIONS.sidebar]
 }

@@ -33,8 +37,9 @@ let cacheRoute = null
 let cacheXhr = null

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

@@ -44,13 +49,27 @@ const mainRender = function (cb) {
    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`
+  }
+
+  // Render Cover page
+  if (OPTIONS.coverpage) {
+    if (page === OPTIONS.homepage) {
+      load(OPTIONS.coverpage).then(render.renderCover)
+    } else {
+      render.renderCover()
+    }
+  }
+
  cacheXhr && cacheXhr.abort && cacheXhr.abort()
  // Render markdown file
-  cacheXhr = load(
-    (!route || /\/$/.test(route)) ? `${route}README.md` : `${route}.md`,
-    'GET',
-    render.renderLoading)
-
+  cacheXhr = load(page, 'GET', render.renderLoading)
  cacheXhr.then(result => {
    render.renderArticle(result)
    if (OPTIONS.loadSidebar) {
@@ -83,6 +102,7 @@ const Docsify = function () {
    mainRender(_ => {
      activeLink('aside.sidebar', true)
      scrollIntoView()
+      OPTIONS.coverpage && sticky()
    })
  }

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

 let OPTIONS = {}
 const CACHE = {}
@@ -32,7 +32,7 @@ renderer.heading = function (text, level) {

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

-  return `<h${level} id="${slug}"><a href="${route}#${slug}" class="anchor"></a>${text}</h${level}>`
+  return `<a href="${route}#${slug}" data-id="${slug}" class="anchor"><h${level} id="${slug}">${text}</h${level}></a>`
 }
 // highlight code
 renderer.code = function (code, lang = '') {
@@ -42,7 +42,7 @@ renderer.code = function (code, lang = '') {
 }
 renderer.link = function (href, title, text) {
  if (OPTIONS.router && !/^(?:\w+:)?\/\/([^\s\.]+\.\S{2}|localhost[\:?\d]*)\S*$/.test(href)) {
-    href = !/^\/#/.test(href) ? `#${href}` : href
+    href = `#/${href}`.replace(/\/\//g, '/')
  }

  return `<a href="${href}" title="${title || ''}">${text}</a>`
@@ -55,11 +55,21 @@ marked.setOptions({ renderer })
 export function renderApp (dom, replace) {
  const nav = document.querySelector('nav') || document.createElement('nav')

-  dom[replace ? 'outerHTML' : 'innerHTML'] = tpl.toggle(OPTIONS.sidebarToggle) + tpl.corner(OPTIONS.repo) + tpl.main()
+  if (!OPTIONS.repo) nav.classList.add('no-badge')
+
+  dom[replace ? 'outerHTML' : 'innerHTML'] = tpl.corner(OPTIONS.repo) +
+    (OPTIONS.coverpage ? tpl.cover() : '') +
+    tpl.main(OPTIONS.sidebarToggle ? tpl.toggle() : '')
  document.body.insertBefore(nav, document.body.children[0])

  // bind toggle
  bindToggle('button.sidebar-toggle')
+  // bind sticky effect
+  if (OPTIONS.coverpage) {
+    !isMobile() && window.addEventListener('scroll', sticky)
+  } else {
+    document.body.classList.add('sticky')
+  }
 }

 /**
@@ -110,12 +120,26 @@ export function renderSidebar (content) {
  toc = []
 }

+/**
+ * Cover Page
+ */
+export function renderCover (content) {
+  renderCover.dom = renderCover.dom || document.querySelector('section.cover')
+  if (!content) {
+    renderCover.dom.classList.add('hidden')
+  } else {
+    renderCover.dom.classList.remove('hidden')
+    !renderCover.rendered && renderTo('.cover-main', marked(content))
+    renderCover.rendered = true
+  }
+}
+
 /**
 * render loading bar
 * @return {[type]} [description]
 */
-export function renderLoading ({ loaded, total }) {
-  const num = Math.floor(loaded / total * 100)
+export function renderLoading ({ loaded, total, step }) {
+  let num

  if (!CACHE.loading) {
    const div = document.createElement('div')
@@ -124,13 +148,19 @@ export function renderLoading ({ loaded, total }) {
    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(_ => {
+    clearTimeout(renderLoading.cacheTimeout)
+    renderLoading.cacheTimeout = setTimeout(_ => {
      CACHE.loading.style.opacity = 0
      CACHE.loading.style.width = '0%'
    }, 200)
@@ -0,0 +1,86 @@
+section.cover {
+  height: 100vh;
+  display: flex;
+  align-items: center;
+
+  &.hidden {
+    display: none;
+  }
+
+  .cover-main {
+    flex: 1;
+    text-align: center;
+    margin: 0 16px;
+  }
+
+  a {
+    color: inherit;
+    text-decoration: none;
+
+    &:hover {
+      text-decoration: none;
+    }
+  }
+
+  p {
+    margin: 1em 0;
+    line-height: 1.5rem;
+  }
+
+  h1 {
+    text-align: center;
+    font-size: 2.5rem;
+    position: relative;
+    margin: .625rem 0 2.5rem;
+    font-weight: 300;
+    color: inherit;
+
+    small {
+      position: absolute;
+      bottom: -.4375rem;
+      font-size: 1rem;
+    }
+  }
+
+  blockquote {
+    text-align: center;
+    font-size: 1.5rem;
+  }
+
+  ul {
+    max-width: 500px;
+    list-style-type: none;
+    margin: 1em auto;
+    padding: 0;
+    line-height: 1.8;
+  }
+
+  .cover-main p:last-child a {
+    border-radius: 2em;
+    border: 1px solid $color-primary;
+    box-sizing: border-box;
+    color: $color-primary;
+    font-size: 1.05em;
+    letter-spacing: 0.1em;
+    padding: 0.75em 2em;
+    text-decoration: none;
+    transition: all 0.15s ease;
+    margin-right: 1em;
+    display: inline-block;
+
+    &:last-child {
+      margin-right: 0;
+      background-color: $color-primary;
+      color: #fff;
+
+      &:hover {
+        opacity: .8;
+        color: inherit;
+      }
+    }
+
+    &:hover {
+      color: inherit;
+    }
+  }
+}
@@ -1,4 +1,3 @@
-
 * {
  box-sizing: border-box;
  -webkit-overflow-scrolling: touch;
@@ -38,6 +37,17 @@ img {
  max-width: 100%;
 }

+kbd {
+  display: inline-block;
+  padding: 3px 5px;
+  margin-bottom : 3px;
+  font-size: 12px !important;
+  line-height: 12px;
+  vertical-align: middle;
+  border: solid 1px #ccc;
+  border-radius: 3px;
+}
+
 /* navbar */
 nav {
  position: absolute;
@@ -47,6 +57,10 @@ nav {
  margin: 25px 60px 0 0;
  text-align: right;

+  &.no-badge {
+    margin-right: 25px;
+  }
+
  p {
    margin: 0;
  }
@@ -124,18 +138,13 @@ nav {

 /* github corner */
 .github-corner {
-  position: absolute;
+  position: fixed;
  top: 0;
  right: 0;
  z-index: 1;
  text-decoration: none;
  border-bottom: 0;

-  &:hover {
-    background-color: inherit;
-    color: inherit;
-  }
-
  &:hover .octo-arm {
    animation:octocat-wave 560ms ease-in-out;
  }
@@ -154,6 +163,16 @@ main {
  position: relative;
 }

+.anchor {
+  text-decoration: none;
+  transition: all .3s;
+  display: block;
+
+  &:hover {
+    text-decoration: underline;
+  }
+}
+
 /* sidebar */
 .sidebar {
  border-right: 1px solid rgba(0, 0, 0, .07);
@@ -209,11 +228,15 @@ main {
  }
 }

+body.sticky {
+  .sidebar, .sidebar-toggle {
+    position: fixed;
+  }
+}
+
 /* main content */
 .content {
-  overflow-y: auto;
  position: absolute 0 0 0 $sidebar-width;
-  overflow-x: hidden;
  padding-top: 20px;
  transition: left 250ms ease;
 }
@@ -235,6 +258,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);
@@ -246,7 +296,7 @@ body.close {
 }

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

@@ -267,8 +317,6 @@ body.close {
    left: 0;
    min-width: 100vw;
    transition: transform 250ms ease;
-    position: static;
-    overflow-y: auto;
  }

  nav, .github-corner {
@@ -4,6 +4,7 @@ $color-primary: #0074D9;
 $sidebar-width: 16em;

@import "basic/layout";
+@import "basic/coverpage";

 body {
  color: #34495e;
@@ -11,6 +12,7 @@ body {
 /* sidebar */
 .sidebar {
  color: #364149;
+  background-color: #fff;

  a {
    color: #666;
@@ -54,6 +56,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 +99,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;
@@ -4,6 +4,7 @@ $color-primary: #42b983;
 $sidebar-width: 300px;

@import "basic/layout";
+@import "basic/coverpage";

 body {
  background-color: #fff;
@@ -13,6 +14,7 @@ body {
 /* sidebar */
 .sidebar {
  color: #364149;
+  background-color: #fff;

  li {
    margin: 6px 15px;
@@ -55,12 +57,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 +96,7 @@ body {
 .markdown-section ul,
 .markdown-section ol {
  line-height: 1.6em;
+  word-spacing: 0.05em;
 }

 .markdown-section ul,
@@ -277,7 +274,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;
@@ -21,10 +21,10 @@ export function corner (data) {

 /**
 * Render main content
- * @return {[type]}      [description]
 */
-export function main () {
+export function main (tpl) {
  return `<main>
+    ${tpl}
    <aside class="sidebar"></aside>
    <section class="content">
      <article class="markdown-section"></article>
@@ -32,8 +32,19 @@ export function main () {
  </main>`
 }

-export function toggle (bool) {
-  if (!bool) return ''
+/**
+ * Cover Page
+ */
+export function cover () {
+  const SL = ', 100%, 85%'
+  const bgc = `linear-gradient(to left bottom, hsl(${Math.floor(Math.random() * 255) + SL}) 0%, hsl(${Math.floor(Math.random() * 255) + SL}) 100%)`
+
+  return `<section class="cover" style="background: ${bgc}">
+    <div class="cover-main"></div>
+  </section>`
+}
+
+export function toggle () {
  return `<button class="sidebar-toggle">
    <span></span><span></span><span></span>
  </button>`
@@ -14,8 +14,14 @@ export function load (url, method = 'GET', loading) {
  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('loaded', loading)
+        xhr.addEventListener('loadend', evt => {
+          loading(evt)
+          clearInterval(id)
+        })
      }
      xhr.addEventListener('error', error)
      xhr.addEventListener('load', ({ target }) => {
@@ -97,6 +103,6 @@ export function getRoute () {
 }

 export function isMobile () {
-  return /mobile/i.test(navigator.userAgent)
+  return document.body.clientWidth <= 600
 }
Author	SHA1	Message	Date
qingwei.li	a0408b7a38	-> v1.3.2	2016-12-23 01:20:57 +08:00
qingwei.li	f917da8214	bump 1.3.2	2016-12-23 01:20:47 +08:00
qingwei.li	64309beee9	Fixed render link	2016-12-23 01:20:28 +08:00
qingwei.li	4c8c0349e6	-> v1.3.1	2016-12-23 00:25:05 +08:00
qingwei.li	91b6720219	bump 1.3.1	2016-12-23 00:24:45 +08:00
qingwei.li	c93ba1ea16	Fixed cover page style	2016-12-23 00:24:24 +08:00
qingwei.li	4f5a150c17	update cdn	2016-12-22 01:03:52 +08:00
qingwei.li	801df6ae3e	Update changelog Update changelog	2016-12-22 00:30:30 +08:00
qingwei.li	6c2e7dca99	-> v1.3.0	2016-12-22 00:26:23 +08:00
qingwei.li	a39eddba74	bump 1.3.0	2016-12-22 00:26:06 +08:00
cinwell.liandGitHub	50addfdac6	1.3 (#38 ) * Add cover page * Update doc * Add kbd style, resolve #37 * headling can cliked, resolve #36 * Update change log, close #35 * Update docs	2016-12-22 00:24:54 +08:00
qingwei.li	b14fcf7d1c	Update readme	2016-12-20 22:34:13 +08:00
qingwei.li	3b02b8fc39	Update features	2016-12-20 22:32:56 +08:00
qingwei.li	039c7a7a6f	Remove donate	2016-12-20 22:19:12 +08:00
qingwei.li	0101492dd4	Update doc	2016-12-20 22:04:55 +08:00
qingwei.li	60fc73c691	update cdn	2016-12-20 21:44:02 +08:00
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