-> v2.0.2

* Destroys the vue instance when the route is changed

* Add new doc helper

* Update docs

.eslintrc

@@ -1,6 +1,7 @@
 {
   "extends": ["vue"],
   "globals": {
-    "XMLHttpRequest": true
+    "XMLHttpRequest": true,
+    "__docsify__": true
   }
 }

.gitignore

@@ -1,4 +1,4 @@
+.DS_Store
 *.log
 node_modules
-yarn.lock
 /themes

CHANGELOG.md

@@ -1,3 +1,209 @@
+## 2.0.2
+
+### Bug fixes
+- fix button style in cover page.
+
+## 2.0.1
+### Bug fixes
+- border style.
+
+## 2.0.0
+### Features
+- Customize the theme color
+
+### Break change
+- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
+
+## 1.10.5
+### Bug fixes
+- fix initialize the Vue instance
+
+## 1.10.4
+### Bug fixes
+- fix execute script
+
+## 1.10.3
+### Bug fixes
+- compatible vuep QingWei-Li/vuep/issues/2
+- fix sidebar scroll, fixed #63
+
+## 1.10.2
+### Bug fixes
+- Fix render emojis again
+
+## 1.10.1
+### Bug fixes
+- Fix render emojis
+
+## 1.10.0
+### Features
+- Support emoji :laughing:
+
+## 1.9.0
+
+### Bug fixes
+- Destroys the vue instance when the route is changed
+
+### Features
+- Add `!>` and `?>` doc helper.
+
+### Break change
+- Remove `!` doc helper.
+
+## 1.8.0
+### Bug fixes
+- Using `v-pre` skip compilation.
+
+### Features
+- Execute script when vue exists.
+
+## 1.7.4
+### Bug fixes
+- Fix bugs caused by the previous version
+
+## 1.7.3
+### Bug fixes
+- Add `hr` style
+- Fixed option is an empty string
+
+## 1.7.2
+### Bug fixes
+- Fix sidebar click event in mobile browser.
+
+## 1.7.1
+### Bug fixes
+- Fix sidebar style in mobile browser.
+
+## 1.7.0
+
+### Bug fixes
+- Fixed custom cover background, fixed #52
+- Fixed sticky sidebar
+
+## Features
+- Add `name` and `nameLink`
+
+## 1.6.1
+### Bug fixes
+- Fixed sidebar bug when the coverpage exist
+
+## 1.6.0
+### Features
+- Improve sidebar performance. The active item is automatically scrolled in the visible view.
+- New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
+
+## 1.5.2
+### Bug fixes
+- Fixed number at the beginning of the slug
+
+## 1.5.1
+### Bug fixes
+- Remove HTML tag when handling slug
+
+## 1.5.0
+
+### Bug fixes
+- Fix slugify.
+- Fix nav highlight.
+
+### Features
+- Initialize the configuration by `window.$docsify`.
+- Markdown parser is configurable.
+
+## 1.4.3
+### Bug fixes
+- Tweak style.
+
+## 1.4.2
+
+### Bug fixes
+- Fix toggle button style.
+- Support `mailto`, `tel`, etc. href type
+- Fix scroll to top.
+
+
+## 1.4.1
+### Bug fixes
+- Fix generate slug.
+
+## 1.4.0 Happly new year 🎉
+### Features
+- Display TOC in the custom sidebar, `data-sub-max-level`.
+- Custom background in coverpage.
+
+### Bug fixes
+- Fix scroll highlight when Vue exist.
+
+## 1.3.5
+### Bug fixes
+- Fix vue
+
+## 1.3.4
+### Bug fixes
+
+- Supports [vuep](https://github.com/QingWei-Li/vuep)
+
+## 1.3.3
+### Bug fixes
+- Fixed cover rendering timing
+
+## 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.1.3
+### Bug fixes
+- Optimize progress bar again
+
 ## 1.1.2
 ### Bug fixes
 - fix failed `auto2top` in mobile

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 cinwell.li
+Copyright (c) 2016 - 2017 cinwell.li
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,36 +1,31 @@
-# 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 (~13kB gzipped)
+- Multiple themes
+- Not build static html files
+- Support emoji :laughing:
 
 ## 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></body>
-<script src="//unpkg.com/docsify"></script>
-</html>
-```
-
-Or Create a `index.html` and using `hash router`.
+Create a `index.html`.
 
 index.html
 
@@ -41,27 +36,60 @@ index.html
   <meta charset="UTF-8">
   <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 </head>
-<body></body>
-<script src="//unpkg.com/docsify" data-router></script>
+<body>
+  <div id="app"></div>
+</body>
+<script src="//unpkg.com/docsify"></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)
+
+## Browser Support
+
+Modern browsers and Internet Explorer 9+.
+
 ## 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.
+- [puck](https://puck.zz173.com/) - A small & magical php framework.
+- [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency.
+- [Vudash](http://vudash.github.io/vudash/) - Powerful, Flexible, Open Source dashboards for anything
+- [Trilogy](http://trilogy.js.org) - No-hassle SQLite with a Promise-based, document store style API.
 
-## How to contribute
+## Similar projects
+- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
+- [docpress](https://github.com/docpress/docpress) - Documentation website generator
+
+## 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
+
+### prepare
+```bash
+npm i && npm run dev
+open http://localhost:3000
+```
+
+### More Language Highlight
+
+```html
+<script src="//unpkg.com/docsify"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-php.js"></script>
+```
 
 ## 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)

app.js

@@ -5,7 +5,7 @@ var fs = require('fs')
 http.createServer(function (req, res) {
   serveStatic('.')(req, res, function () {
     res.writeHead(404, { 'Content-Type': 'text/html' })
-    res.end(fs.readFileSync('404.dev.html'))
+    res.end(fs.readFileSync('dev.html'))
   })
 }).listen(3000, '0.0.0.0')
 

build/build-css.js

@@ -3,7 +3,15 @@ var cssnano = require('cssnano').process
 var resolve = require('path').resolve
 var postcss = require('postcss')
 
-var processor = postcss([require('postcss-salad')])
+var processor = postcss([require('postcss-salad')({
+  features: {
+    precss: {
+      properties: {
+        preserve: true
+      }
+    }
+  }
+})])
 
 var saveMin = function (file, content) {
   fs.writeFileSync(resolve(__dirname, '../lib/themes/', file), content)

dev.html

@@ -5,8 +5,8 @@
   <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="/themes/vue.css">
 </head>
-<body class="">
+<body>
   <div id="app"></div>
 </body>
-<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-auto2top data-sidebar-toggle data-router></script>
+<script src="/lib/docsify.js" data-repo="qingwei-li/docsify" data-name="docsify" data-auto2top></script>
 </html>

docs/README.md

@@ -1,23 +1,14 @@
-# docsify
-
-> A magical documentation site generator.
-
-## Features
-- Easy and lightweight
-- Custom themes
-- No build
-
 ## Quick Start
 
 ### Create a project
 First create a project, then create a `docs` folder
-```shell
+```bash
 mkdir my-project && cd my-project
 mkdir docs && cd docs
 ```
 
 ### Create entry file
-Create a `404.html` file
+Create a `index.html` file
 
 ```html
 <!DOCTYPE html>
@@ -35,41 +26,45 @@ Create a `404.html` file
 
 Create `README.md` as the main page
 
-```
+```markdown
 # Title
 
-## balabala
+## blabla
 ```
 
 ### Deploy!
-Push and open the **GitHub Pages** feature
+Push code and activate **GitHub Pages** via your repo's settings
 ![image](https://cloud.githubusercontent.com/assets/7565692/20639058/e65e6d22-b3f3-11e6-9b8b-6309c89826f2.png)
 
 ## CLI
 
-Easy to setup and preivew a docs.
+Easy to setup and preview a docs.
 
 ### Install
-```shell
+```bash
 npm i docsify-cli -g
 ```
 
 ### Setup
 
 Setup a boilerplate docs
-```shell
+```bash
 docsify init docs
 ```
 
 ### Preview
 Preview and serve your docs using
-```shell
+```bash
 docsify serve docs
 ```
 
 Read more [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
 
-## Themes
+
+
+## More
+
+### Themes
 Currently available `vue.css` and `buble.css`
 ```html
 <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
@@ -83,79 +78,192 @@ Minified files
 <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
 ```
 
-## More
-
 ### Multiple pages
-If you need other pages, directly create the markdown file, such as `guide.md` is `/guide`.
+If you need other pages, directly create the markdown file, such as `guide.md` is `/#/guide`.
 
 ### Navbar
-Code in `404.html`
+Code in `index.html`
 
 ```html
 <nav>
-  <a href="/docsify/">En</a>
-  <a href="/docsify/zh-cn">中文</a>
+  <a href="/#/docsify/">En</a>
+  <a href="/#/docsify/zh-cn">中文</a>
 </nav>
 ```
 
-### Options
+### CDN
+- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
+- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
 
-#### repo
+
+### Cover Page
+
+Generate a cover page with markdown. Create a `_coverpage.md` and set `data-coverpage` in the 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)
+```
+
+#### Custom background
+Currently the background of the cover page is generated randomly. We can customize the background color, or add a background image.
+
+```markdown
+# docsify <small>1.2.0</small>
+
+> xxx
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+
+<!-- background image -->
+![](_media/bg.png)
+<!-- background color -->
+![color](#f0f0f0)
+```
+
+### Markdown parser
+
+Docsify uses [marked](https://github.com/chjj/marked) to parse markdown. We can configure it
+
+```js
+window.$docsify = {
+  markdown: {
+    smartypants: true
+  }
+}
+```
+
+And it can even be customized
+
+```js
+window.$docsify = {
+  markdown: function(marked) {
+    // ...
+
+    return marked
+  }
+}
+```
+
+### Doc Helpers
+#### p.tip
+
+`!> ` add your content will rendered as `<p class="tip">content</p>`
+
+```markdown
+!> Important **information**
+```
+
+It will be rendered
+
+```html
+<p class="tip">Important <strong>information</strong></p>
+```
+
+e.g.
+
+!> Important **information**
+
+
+#### p.warn
+
+```markdown
+?> todo info
+```
+
+?> todo info
+
+### Combining Vue
+We can write the Vue syntax directly in the markdown file, when the Vue library is loaded into `index.html`. Default will automatically initialize a Vue instance, of course, we can also manually.
+
+index.html
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+```markdown
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+Manual initialization
+
+```markdown
+<div>
+  <input type="text" v-model="msg">
+  <p>Hello, {{ msg }}</p>
+</div>
+
+<script>
+  new Vue({
+    el: 'main',
+    data: { msg: 'Docsify' }
+  })
+</script>
+```
+
+## Options
+
+You can add configurations in the script tag attributes or with `window.$docsify`.
+
+### repo
 Display the [GitHub Corner](http://tholman.com/github-corners/) widget.
 
 ```html
 <script src="//unpkg.com/docsify" data-repo="your/repo"></script>
 ```
 
-#### max-level
-Toc level.
+
+```js
+window.$docsify = {
+  repo: 'your/repo'
+}
+```
+
+### max-level
+TOC level.
 
 ```html
 <script src="//unpkg.com/docsify" data-max-level="6"></script>
 ```
 
-#### el
+```js
+window.$docsify = {
+  maxLevel: 6
+}
+```
+
+### el
 Root element.
 
 ```html
 <script src="//unpkg.com/docsify" data-el="#app"></script>
 ```
 
-#### sidebar-toggle
-
-Sidebar with toggle
-
-```html
-<script src="//unpkg.com/docsify" data-sidebar-toggle></script>
+```js
+window.$docsify = {
+  el: '#app'
+}
 ```
 
-#### sidebar
+### load-sidebar
 
-Custom sidebar. if it'set, the TOC will be disabeld. Bind global variables on the `data-sidebar`.
-
-![image](https://cloud.githubusercontent.com/assets/7565692/20647425/de5ab1c2-b4ce-11e6-863a-135868f2f9b4.png)
-
-```html
-<script>
-  window.sidebar = [
-    { slug: '/', title: 'Home' },
-    {
-      slug: '/pageA',
-      title: 'page A',
-      children: [
-        { slug: '/pageA/childrenB', title: 'children B' }
-      ]
-    },
-    { slug: '/PageC', title: 'Page C' }
-  ]
-</script>
-<script src="/lib/docsify.js" data-sidebar="sidebar"></script>
-```
-
-
-#### 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.
+Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file doesn't exist, the sidebar will appear as a 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>
@@ -167,6 +275,12 @@ You can specify a file:
 <script src="/lib/docsify.js" data-load-sidebar="_sidebar.md"></script>
 ```
 
+```js
+window.$docsify = {
+  loadSidebar: '_sidebar.md'
+}
+```
+
 The contents of the file can be:
 
 ```markdown
@@ -176,16 +290,27 @@ The contents of the file can be:
   - [Getting Started](/getting-started)
   - [Dynamic Route Matching](/dynamic-matching)
   - [Nested Routes](/nested-routes)
-  - [Programmatic Navigation](/navigation)
-  - [Named Routes](/named-routes)
-  - [Named Views](/named-views)
-  - [Redirect and Alias](/redirect-and-alias)
-  - [HTML5 History Mode](/history-mode)
 ```
 
-#### load-navbar
+### sub-max-level
 
-Load navbar markdown file. If it is configured, load  the current directory `_navbar.md` by default.
+Display TOC in the custom sidebar. The default value is 0.
+
+
+```html
+<script src="/lib/docsify.js" data-load-sidebar data-max-sub-level="4"></script>
+```
+
+
+```js
+window.$docsify = {
+  maxSubLevel: 4
+}
+```
+
+### load-navbar
+
+Load navbar markdown file. If it is configured, load the current directory `_navbar.md` by default.
 
 ```html
 <script src="/lib/docsify.js" data-load-navbar></script>
@@ -197,6 +322,12 @@ You can specify a file:
 <script src="/lib/docsify.js" data-load-navbar="_navbar.md"></script>
 ```
 
+```js
+window.$docsify = {
+  loadNavbar: '_navbar.md'
+}
+```
+
 The contents of the file can be:
 
 ```markdown
@@ -213,13 +344,6 @@ If you write a sub level list, it will generate a dropdown list.
   - [chinese](/zh-cn)
 ```
 
-### router
-
-Hash router. You can replace `404.html` with `index.html`.
-
-```html
-<script src="/lib/docsify.js" data-router></script>
-```
 
 ### auto2top
 
@@ -228,5 +352,110 @@ Scroll to the top on changing hash.
 
 ```html
 <script src="/lib/docsify.js" data-auto2top></script>
+<!-- Set offset top -->
+<script src="/lib/docsify.js" data-auto2top="50"></script>
 ```
 
+```js
+window.$docsify = {
+  auto2top: true,
+  // auto2top: 50
+}
+```
+
+### homepage
+
+`README.md` will be rendered as a homepage for your website in the docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo.
+
+```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>
+```
+
+
+```js
+window.$docsify = {
+  homepage: true
+}
+```
+
+
+### base-path
+
+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>
+```
+
+
+```js
+window.$docsify = {
+  basePath: '/base/'
+}
+```
+
+
+### coverpage
+
+Generate cover page.
+
+```html
+<script src="/lib/docsify.js" data-coverpage></script>
+<!-- or -->
+<script src="/lib/docsify.js" data-coverpage="other.md"></script>
+```
+
+```js
+window.$docsify = {
+  coverpage: true
+}
+```
+
+### name
+
+Project name. It is displayed in the sidebar.
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### name-link
+
+Name link. The default value is `window.location.pathname`.
+
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+
+### theme-color
+
+Customize the theme color.
+
+
+```html
+<script src="/lib/docsify.js" data-theme-color="#3F51B5"></script>
+```
+
+```js
+window.$docsify = {
+  themeColor: '#3F51B5'
+}
+```

docs/_coverpage.md

@@ -0,0 +1,14 @@
+![logo](_media/icon.svg)
+
+# docsify <small>2.0.2</small>
+
+> A magical documentation site generator.
+
+- Simple and lightweight (~13kB gzipped)
+- Not build static html files
+- Support emoji :laughing:
+- Multiple themes
+
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)

docs/_media/icon.svg

@@ -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>

docs/index.html

@@ -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,9 @@
 </body>
 <script
   src="//unpkg.com/docsify/lib/docsify.min.js"
-  data-repo="qingwei-li/docsify"
-  data-max-level="3"
-  data-sidebar-toggle
-  data-router></script>
+  data-max-level="4"
+  data-coverpage
+  data-name="docsify"></script>
+<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
 </html>

docs/zh-cn.md

@@ -1,23 +1,20 @@
-# docsify
-
-> 无需构建快速生成文档页
 
 ## 特性
 - 无需构建，写完 markdown 直接发布
 - 支持自定义主题
-- 容易使用并且轻量
+- 容易使用并且轻量 (~12kb gzipped)
 
 ## 快速上手
 
 ### 创建项目
 新建一个空项目，接着创建一个 `docs` 目录并进入到 docs 目录下
-```shell
+```bash
 mkdir my-project && cd my-project
 mkdir docs && cd docs
 ```
 
 ### 创建入口文件
-创建一个 `404.html` 文件，内容为
+创建一个 `index.html` 文件，内容为
 ```html
 <!DOCTYPE html>
 <html>
@@ -49,27 +46,30 @@ mkdir docs && cd docs
 方便快速创建文档目录，会读取项目的 `package.json` 里的选项作为 docsify 的配置，支持本地预览。
 
 ### 安装
-```shell
+```bash
 npm i docsify-cli -g
 ```
 
 ### 初始化文档
 
 默认初始化在当前目录，推荐将文档放在 `docs` 目录下
-```shell
+```bash
 docsify init docs
 ```
 
 ### 启动本地服务
 启动一个 server 方便预览，打开 http://localhost:3000
-```shell
+```bash
 docsify serve docs
 ```
 
 更多选项参考 [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
 
-## 主题
-目前提供 vue.css 和 buble.css，直接修改 `404.html` 里的 cdn 地址即可
+
+## 更多功能
+
+### 主题
+目前提供 vue.css 和 buble.css，直接修改 `index.html` 里的 cdn 地址即可
 ```html
 <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
 <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
@@ -82,92 +82,217 @@ docsify serve docs
 <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css">
 ```
 
-## 更多功能
-
 ### 多页面
-`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/guide`。
+`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/#/guide`。
 
 ### 导航
-导航需要自己写在 `404.html` 文件里，效果参考本文档
+导航需要自己写在 `index.html` 文件里，效果参考本文档
 
 ```html
 <nav>
-  <a href="/docsify/">En</a>
-  <a href="/docsify/zh-cn">中文</a>
+  <a href="/#/docsify/">En</a>
+  <a href="/#/docsify/zh-cn">中文</a>
 </nav>
 ```
 
+
+
 ### CDN
+- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
+- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
 
-目前可用的 CDN 有 [UNPKG](unpkg.com/docsify)，如果觉得访问较慢可以将文件放到 Pages 的目录下。
+### 封面
 
-### 配置参数
+只需要写几行简单的 markdown 就可以拥有一页精致的封面，通过添加 `data-coverpage` 属性，并创建 `_coverpage.md`，按照下面的格式书写即可。
 
-#### repo
-参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `404.html` 里的 script 改成
+```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)
+```
+
+
+#### 自定义封面背景
+默认的背景是随机生成的，你可以自定义背景色或者背景图片。只需要在文档末尾用添加图片的 Markdown 语法
+
+```markdown
+# docsify <small>1.2.0</small>
+
+> xxx
+
+[GitHub](https://github.com/QingWei-Li/docsify/)
+[Get Started](#quick-start)
+
+<!-- 背景图片 -->
+![](_media/bg.png)
+<!-- 背景色 -->
+![color](#f0f0f0)
+```
+
+### 自定义 Markdown parser
+
+默认使用 [marked](https://github.com/chjj/marked) 处理 markdown 部分，你可以修改默认配置
+
+```js
+window.$docsify = {
+  markdown: {
+    smartypants: true
+  }
+}
+```
+
+甚至可以完全定制化
+
+```js
+window.$docsify = {
+  markdown: function(marked) {
+    // ...
+
+    return marked
+  }
+}
+```
+
+### 文档助手
+#### 内置「提示」语法
+
+`!>`后面接内容，会渲染成带 tip 类名的段落。
+
+```markdown
+!> 提示信息，**支持其他 markdown 语法**
+```
+
+将被渲染成
+
+```html
+<p class="tip">提示信息<strong>支持其他 markdown 语法</strong></p>
+```
+
+效果
+
+!> 适合显示醒目的内容
+
+#### 内置「警示」语法
+
+`?>`后面接内容，会渲染成带 warn 类名的段落。
+
+```markdown
+?> 警示内容样式
+```
+
+效果
+
+?> 警示内容样式
+
+### 结合 Vue
+
+`index.html` 内引入 Vue 后，可以在文档里直接写 Vue 语法。默认会自己初始化一个 Vue 示例，当然我们也可以手动初始化一个实例。
+
+index.html
+```html
+<script src="//unpkg.com/vue"></script>
+<script src="//unpkg.com/docsify"></script>
+```
+
+```markdown
+<ul>
+  <li v-for="i in 10">{{ i }}</li>
+</ul>
+```
+
+手动初始化示例
+
+```markdown
+<div>
+  <input type="text" v-model="msg">
+  <p>Hello, {{ msg }}</p>
+</div>
+
+<script>
+  new Vue({
+    el: 'main',
+    data: { msg: 'Docsify' }
+  })
+</script>
+```
+
+## 配置参数
+
+你可以通过在标签上添加属性的方式，或者给 `window.$docsify` 传配置信息。
+
+### repo
+参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `index.html` 里的 script 改成
 
 ```html
 <script src="//unpkg.com/docsify" data-repo="your/repo"></script>
 ```
 
-#### max-level
+
+```js
+window.$docsify = {
+  repo: 'your/repo'
+}
+```
+
+### max-level
 目录最大展开层级，默认值为 6
 
 ```html
 <script src="//unpkg.com/docsify" data-max-level="6"></script>
 ```
 
-#### el
+
+```js
+window.$docsify = {
+  maxLevel: 6
+}
+```
+
+### el
 替换节点元素，默认为 `#app`
 ```html
 <script src="//unpkg.com/docsify" data-el="#app"></script>
 ```
 
-#### sidebar-toggle
 
-Sidebar 开关按钮
-
-```html
-<script src="//unpkg.com/docsify" data-sidebar-toggle></script>
+```js
+window.$docsify = {
+  el: '#app'
+}
 ```
 
-#### sidebar
-
-设置后 TOC 功能将不可用，适合导航较多的文档，`data-sidebar` 传入全局变量名。
-
-![image](https://cloud.githubusercontent.com/assets/7565692/20647425/de5ab1c2-b4ce-11e6-863a-135868f2f9b4.png)
-
-```html
-<script>
-  window.sidebar = [
-    { slug: '/', title: 'Home' },
-    {
-      slug: '/pageA',
-      title: 'page A',
-      children: [
-        { slug: '/pageA/childrenB', title: 'children B' }
-      ]
-    },
-    { slug: '/PageC', title: 'Page C' }
-  ]
-</script>
-<script src="/lib/docsify.js" data-sidebar="sidebar"></script>
-```
-
-#### load-sidebar
+### load-sidebar
 
 读取侧边栏配置文件，如果配置，默认加载当前目录下的 `_sidebar.md`。如果文件不存在，会显示 TOC 作为侧边栏内容。如果你有二级目录，也应该放置一份配置文件。
+**如果用 `_` 开头作为文件名，你应该在文档目录下添加 `.nojekyll`，阻止 GitHub Pages 忽略下划线开头的文件。**
 
 ```html
 <script src="/lib/docsify.js" data-load-sidebar></script>
 ```
 
+
 你可以指定侧边栏文件名
 
 ```html
 <script src="/lib/docsify.js" data-load-sidebar="_sidebar.md"></script>
 ```
 
+```js
+window.$docsify = {
+  loadSidebar: '_sidebar.md'
+}
+```
+
 `_sidebar.md` 的内容可以是这样的
 
 ```markdown
@@ -177,14 +302,24 @@ Sidebar 开关按钮
   - [Getting Started](/getting-started)
   - [Dynamic Route Matching](/dynamic-matching)
   - [Nested Routes](/nested-routes)
-  - [Programmatic Navigation](/navigation)
-  - [Named Routes](/named-routes)
-  - [Named Views](/named-views)
-  - [Redirect and Alias](/redirect-and-alias)
-  - [HTML5 History Mode](/history-mode)
 ```
 
-#### load-navbar
+### sub-max-level
+
+显示 TOC 在自定义的侧边栏里，默认最大显示 0 层。
+
+
+```html
+<script src="/lib/docsify.js" data-load-sidebar data-max-sub-level="4"></script>
+```
+
+```js
+window.$docsify = {
+  maxSubLevel: 4
+}
+```
+
+### load-navbar
 
 读取导航配置文件，如果配置，默认加载当前目录下的 `_navbar.md`。如果文件不存在，会显示 html 里定义的导航栏。
 
@@ -198,6 +333,12 @@ Sidebar 开关按钮
 <script src="/lib/docsify.js" data-load-navbar="_navbar.md"></script>
 ```
 
+```js
+window.$docsify = {
+  loadNavbar: '_navbar.md'
+}
+```
+
 `_navbar.md` 的内容可以是这样
 
 ```markdown
@@ -214,14 +355,6 @@ Sidebar 开关按钮
 ```
 
 
-### router
-
-开启 hash router 功能，此时可以创建 `index.html` 作为入口文件，同时多页面切换不会重新加载资源。资源路径会被替换成 `/#/` 的形式。
-
-```html
-<script src="/lib/docsify.js" data-router></script>
-```
-
 ### auto2top
 
 切换路由时自动跳转到页面顶部
@@ -231,3 +364,105 @@ Sidebar 开关按钮
 <script src="/lib/docsify.js" data-auto2top></script>
 ```
 
+```js
+window.$docsify = {
+  auto2top: true
+}
+```
+
+### 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>
+```
+
+```js
+window.$docsify = {
+  homepage: true
+}
+```
+
+### base-path
+
+指定加载文档的路径，如果你的 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>
+```
+
+
+```js
+window.$docsify = {
+  basePath: '/base/'
+}
+```
+
+### coverpage
+
+生成封面，参考 [#封面](/zh-cn#封面).
+
+```html
+<script src="/lib/docsify.js" data-coverpage></script>
+<!-- or -->
+<script src="/lib/docsify.js" data-coverpage="other.md"></script>
+
+```
+
+
+```js
+window.$docsify = {
+  coverpage: true
+}
+```
+
+
+### name
+
+项目名，将显示在侧边栏。
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### name-link
+
+项目名链接，默认为 `window.location.pathname`。
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+
+### theme-color
+
+自定义主题色。
+
+
+```html
+<script src="/lib/docsify.js" data-theme-color="#3F51B5"></script>
+```
+
+```js
+window.$docsify = {
+  themeColor: '#3F51B5'
+}
+```

lib/docsify.js

@@ -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,67 @@ function getRoute () {
 }
 
 function isMobile () {
-  return /mobile/i.test(navigator.userAgent)
+  return document.body.clientWidth <= 600
+}
+
+function slugify (string) {
+  var re = /[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,.\/:;<=>?@\[\]^`{|}~]/g;
+  var maintainCase = false;
+  var replacement = '-';
+
+  slugify.occurrences = slugify.occurrences || {};
+
+  if (typeof string !== 'string') { return '' }
+  if (!maintainCase) { string = string.toLowerCase(); }
+
+  var slug = string.trim()
+    .replace(/<[^>\d]+>/g, '')
+    .replace(re, '')
+    .replace(/\s/g, replacement)
+    .replace(/-+/g, replacement)
+    .replace(/^(\d)/, '_$1');
+  var occurrences = slugify.occurrences[slug];
+
+  if (slugify.occurrences.hasOwnProperty(slug)) {
+    occurrences++;
+  } else {
+    occurrences = 0;
+  }
+
+  slugify.occurrences[slug] = occurrences;
+
+  if (occurrences) {
+    slug = slug + '-' + occurrences;
+  }
+
+  return slug
+}
+
+slugify.clear = function () {
+  slugify.occurrences = {};
+};
+
+var hasOwnProperty = Object.prototype.hasOwnProperty;
+var merge = Object.assign || function (to) {
+  var arguments$1 = arguments;
+
+  for (var i = 1; i < arguments.length; i++) {
+    var from = Object(arguments$1[i]);
+
+    for (var key in from) {
+      if (hasOwnProperty.call(from, key)) {
+        to[key] = from[key];
+      }
+    }
+  }
+
+  return to
+};
+
+function emojify (text) {
+  return text
+    .replace(/:(\w*?):/ig, '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/$1.png" alt="$1" />')
+    .replace(/__colon__/g, ':')
 }
 
 /**
@@ -116,51 +181,84 @@ function isMobile () {
 function scrollActiveSidebar () {
   if (isMobile()) { return }
 
+  var hoveredOverSidebar = false;
   var anchors = document.querySelectorAll('.anchor');
+  var sidebar = document.querySelector('aside.sidebar');
+  var sidebarHeight = sidebar.clientHeight;
+
   var nav = {};
-  var lis = document.querySelectorAll('.sidebar li');
-  var active = null;
+  var lis = sidebar.querySelectorAll('li');
+  var active = sidebar.querySelector('li.active');
 
   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); }
+    if (href !== '/') {
+      var match = href.match('#([^#]+)$');
+      if (match && match.length) { href = match[0].slice(1); }
+    }
 
-    nav[href] = li;
+    nav[decodeURIComponent(href)] = li;
   }
 
   function highlight () {
+    var top = document.body.scrollTop;
+    var last;
+
     for (var i = 0, len = anchors.length; i < len; i += 1) {
-      var node = anchors[i].parentNode;
-      var bcr = node.getBoundingClientRect();
+      var node = anchors[i];
 
-      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
+      if (node.offsetTop > top) {
+        if (!last) { last = node; }
+        break
+      } else {
+        last = node;
       }
     }
+    if (!last) { return }
+    var li = nav[last.getAttribute('data-id')];
+
+    if (!li || li === active) { return }
+    if (active) { active.classList.remove('active'); }
+
+    li.classList.add('active');
+    active = li;
+
+    // scroll into view
+    // https://github.com/vuejs/vuejs.org/blob/master/themes/vue/source/js/common.js#L282-L297
+    if (!hoveredOverSidebar && !sticky.noSticky) {
+      var currentPageOffset = 0;
+      var currentActiveOffset = active.offsetTop + active.clientHeight + 40;
+      var currentActiveIsInView = (
+        active.offsetTop >= sidebar.scrollTop &&
+        currentActiveOffset <= sidebar.scrollTop + sidebarHeight
+      );
+      var linkNotFurtherThanSidebarHeight = currentActiveOffset - currentPageOffset < sidebarHeight;
+      var newScrollTop = currentActiveIsInView
+        ? sidebar.scrollTop
+        : linkNotFurtherThanSidebarHeight
+          ? currentPageOffset
+          : currentActiveOffset - sidebarHeight;
+
+      sidebar.scrollTop = newScrollTop;
+    }
   }
 
-  var dom = document.querySelector('main .content');
-  dom.removeEventListener('scroll', highlight);
-  dom.addEventListener('scroll', highlight);
-  highlight();
+  window.removeEventListener('scroll', highlight);
+  window.addEventListener('scroll', highlight);
+  sidebar.addEventListener('mouseover', function () { hoveredOverSidebar = true; });
+  sidebar.addEventListener('mouseleave', function () { hoveredOverSidebar = false; });
 }
 
 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(); }
+  if (section) { setTimeout(function () { return section.scrollIntoView(); }, 0); }
+
+  return section
 }
 
 /**
@@ -170,19 +268,23 @@ function activeLink (dom, activeParent) {
   var host = window.location.href;
 
   dom = typeof dom === 'object' ? dom : document.querySelector(dom);
-  if (!dom) { return
+  if (!dom) { return }
+  var target;[].slice.call(dom.querySelectorAll('a'))
+    .sort(function (a, b) { return b.href.length - a.href.length; })
+    .forEach(function (node) {
+      if (host.indexOf(node.href) === 0 && !target) {
+        activeParent
+          ? node.parentNode.classList.add('active')
+          : node.classList.add('active');
+        target = node;
+      } else {
+        activeParent
+          ? node.parentNode.classList.remove('active')
+          : node.classList.remove('active');
+      }
+    });
 
-  ; }[].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');
-    }
-  });
+  return target
 }
 
 /**
@@ -195,19 +297,34 @@ function bindToggle (dom) {
 
   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');
-  });
+  if (isMobile()) {
+    var sidebar = document.querySelector('aside.sidebar');
+    sidebar.addEventListener('click', function () {
+      body.classList.toggle('close');
+      setTimeout(function () { return activeLink(sidebar, true); }, 0);
+    });
+  }
 }
 
-var cacheContentDOM;
-function scroll2Top () {
-  if (!cacheContentDOM) {
-    var dom = isMobile() ? 'body' : 'section.content';
-    cacheContentDOM = document.querySelector(dom);
-  }
-  cacheContentDOM.scrollTop = 0;
+function scroll2Top (offset) {
+  if ( offset === void 0 ) offset = 0;
+
+  document.body.scrollTop = offset === true ? 0 : Number(offset);
+}
+
+function sticky () {
+  sticky.dom = sticky.dom || document.querySelector('section.cover');
+  var coverHeight = sticky.dom.getBoundingClientRect().height;
+
+  return (function () {
+    if (window.pageYOffset >= coverHeight || sticky.dom.classList.contains('hidden')) {
+      document.body.classList.add('sticky');
+      sticky.noSticky = false;
+    } else {
+      document.body.classList.remove('sticky');
+      sticky.noSticky = true;
+    }
+  })()
 }
 
 var commonjsGlobal = typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
@@ -1508,12 +1625,8 @@ marked.inlineLexer = InlineLexer.output;
 
 marked.parse = marked;
 
-if (typeof module !== 'undefined' && typeof exports === 'object') {
+{
   module.exports = marked;
-} else if (typeof define === 'function' && define.amd) {
-  define(function() { return marked; });
-} else {
-  this.marked = marked;
 }
 
 }).call(function() {
@@ -1731,6 +1844,9 @@ var _ = _self.Prism = {
 		_.hooks.run('before-sanity-check', env);
 
 		if (!env.code || !env.grammar) {
+			if (env.code) {
+				env.element.textContent = env.code;
+			}
 			_.hooks.run('complete', env);
 			return;
 		}
@@ -1808,9 +1924,16 @@ var _ = _self.Prism = {
 					lookbehindLength = 0,
 					alias = pattern.alias;
 
+				if (greedy && !pattern.pattern.global) {
+					// Without the global flag, lastIndex won't work
+					var flags = pattern.pattern.toString().match(/[imuy]*$/)[0];
+					pattern.pattern = RegExp(pattern.pattern.source, flags + "g");
+				}
+
 				pattern = pattern.pattern || pattern;
 
-				for (var i=0; i<strarr.length; i++) { // Don’t cache length as it changes during the loop
+				// Don’t cache length as it changes during the loop
+				for (var i=0, pos = 0; i<strarr.length; pos += strarr[i].length, ++i) {
 
 					var str = strarr[i];
 
@@ -1830,40 +1953,38 @@ var _ = _self.Prism = {
 
 					// Greedy patterns can override/remove up to two previously matched tokens
 					if (!match && greedy && i != strarr.length - 1) {
-						// Reconstruct the original text using the next two tokens
-						var nextToken = strarr[i + 1].matchedStr || strarr[i + 1],
-						    combStr = str + nextToken;
-
-						if (i < strarr.length - 2) {
-							combStr += strarr[i + 2].matchedStr || strarr[i + 2];
-						}
-
-						// Try the pattern again on the reconstructed text
-						pattern.lastIndex = 0;
-						match = pattern.exec(combStr);
+						pattern.lastIndex = pos;
+						match = pattern.exec(text);
 						if (!match) {
-							continue;
+							break;
 						}
 
-						var from = match.index + (lookbehind ? match[1].length : 0);
-						// To be a valid candidate, the new match has to start inside of str
-						if (from >= str.length) {
+						var from = match.index + (lookbehind ? match[1].length : 0),
+						    to = match.index + match[0].length,
+						    k = i,
+						    p = pos;
+
+						for (var len = strarr.length; k < len && p < to; ++k) {
+							p += strarr[k].length;
+							// Move the index i to the element in strarr that is closest to from
+							if (from >= p) {
+								++i;
+								pos = p;
+							}
+						}
+
+						/*
+						 * If strarr[i] is a Token, then the match starts inside another Token, which is invalid
+						 * If strarr[k - 1] is greedy we are in conflict with another greedy pattern
+						 */
+						if (strarr[i] instanceof Token || strarr[k - 1].greedy) {
 							continue;
 						}
-						var to = match.index + match[0].length,
-						    len = str.length + nextToken.length;
 
 						// Number of tokens to delete and replace with the new match
-						delNum = 3;
-
-						if (to <= len) {
-							if (strarr[i + 1].greedy) {
-								continue;
-							}
-							delNum = 2;
-							combStr = combStr.slice(0, len);
-						}
-						str = combStr;
+						delNum = k - i;
+						str = text.slice(pos, p);
+						match.index -= pos;
 					}
 
 					if (!match) {
@@ -1932,7 +2053,7 @@ var Token = _.Token = function(type, content, alias, matchedStr, greedy) {
 	this.content = content;
 	this.alias = alias;
 	// Copy of the full string this token was created from
-	this.matchedStr = matchedStr || null;
+	this.length = (matchedStr || "").length|0;
 	this.greedy = !!greedy;
 };
 
@@ -1968,13 +2089,11 @@ Token.stringify = function(o, language, parent) {
 
 	_.hooks.run('wrap', env);
 
-	var attributes = '';
+	var attributes = Object.keys(env.attributes).map(function(name) {
+		return name + '="' + (env.attributes[name] || '').replace(/"/g, '&quot;') + '"';
+	}).join(' ');
 
-	for (var name in env.attributes) {
-		attributes += (attributes ? ' ' : '') + name + '="' + (env.attributes[name] || '') + '"';
-	}
-
-	return '<' + env.tag + ' class="' + env.classes.join(' ') + '" ' + attributes + '>' + env.content + '</' + env.tag + '>';
+	return '<' + env.tag + ' class="' + env.classes.join(' ') + '"' + (attributes ? ' ' + attributes : '') + '>' + env.content + '</' + env.tag + '>';
 
 };
 
@@ -2007,7 +2126,11 @@ if (script) {
 
 	if (document.addEventListener && !script.hasAttribute('data-manual')) {
 		if(document.readyState !== "loading") {
-			requestAnimationFrame(_.highlightAll, 0);
+			if (window.requestAnimationFrame) {
+				window.requestAnimationFrame(_.highlightAll);
+			} else {
+				window.setTimeout(_.highlightAll, 16);
+			}
 		}
 		else {
 			document.addEventListener('DOMContentLoaded', _.highlightAll);
@@ -2019,7 +2142,7 @@ return _self.Prism;
 
 })();
 
-if (typeof module !== 'undefined' && module.exports) {
+if ('object' !== 'undefined' && module.exports) {
 	module.exports = Prism;
 }
 
@@ -2036,10 +2159,10 @@ if (typeof commonjsGlobal !== 'undefined') {
 Prism.languages.markup = {
 	'comment': /<!--[\w\W]*?-->/,
 	'prolog': /<\?[\w\W]+?\?>/,
-	'doctype': /<!DOCTYPE[\w\W]+?>/,
+	'doctype': /<!DOCTYPE[\w\W]+?>/i,
 	'cdata': /<!\[CDATA\[[\w\W]*?]]>/i,
 	'tag': {
-		pattern: /<\/?(?!\d)[^\s>\/=.$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i,
+		pattern: /<\/?(?!\d)[^\s>\/=$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i,
 		inside: {
 			'tag': {
 				pattern: /^<\/?[^\s>\/]+/i,
@@ -2096,7 +2219,10 @@ Prism.languages.css = {
 	},
 	'url': /url\((?:(["'])(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1|.*?)\)/i,
 	'selector': /[^\{\}\s][^\{\};]*?(?=\s*\{)/,
-	'string': /("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/,
+	'string': {
+		pattern: /("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/,
+		greedy: true
+	},
 	'property': /(\b|\B)[\w-]+(?=\s*:)/i,
 	'important': /\B!important\b/i,
 	'function': /[-a-z0-9]+(?=\()/i,
@@ -2177,7 +2303,8 @@ Prism.languages.javascript = Prism.languages.extend('clike', {
 	'keyword': /\b(as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|var|void|while|with|yield)\b/,
 	'number': /\b-?(0x[\dA-Fa-f]+|0b[01]+|0o[0-7]+|\d*\.?\d+([Ee][+-]?\d+)?|NaN|Infinity)\b/,
 	// Allow for all non-ASCII characters (See http://stackoverflow.com/a/2008444)
-	'function': /[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*(?=\()/i
+	'function': /[_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*(?=\()/i,
+	'operator': /--?|\+\+?|!=?=?|<=?|>=?|==?=?|&&?|\|\|?|\?|\*\*?|\/|~|\^|%|\.{3}/
 });
 
 Prism.languages.insertBefore('javascript', 'keyword', {
@@ -2319,15 +2446,26 @@ 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>"
+  var aside = (toggle()) + "<aside class=\"sidebar\"></aside>";
+
+  return (isMobile() ? (aside + "<main>") : ("<main>" + aside)) +
+    "<section class=\"content\">\n      <article class=\"markdown-section\"></article>\n    </section>\n    </main>"
 }
 
-function toggle (bool) {
-  if (!bool) { return '' }
-  return "<button class=\"sidebar-toggle\">\n    <span></span><span></span><span></span>\n  </button>"
+/**
+ * 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    <div class=\"mask\"></div>\n  </section>")
+}
+
+function toggle () {
+  return "<button class=\"sidebar-toggle\">\n      <div class=\"sidebar-toggle-button\">\n        <span></span><span></span><span></span>\n      </div>\n    </button>"
 }
 
 /**
@@ -2351,50 +2489,103 @@ function tree (toc, tpl) {
   return tpl
 }
 
-var OPTIONS$1 = {};
+function helper (className, content) {
+  return ("<p class=\"" + className + "\">" + (content.slice(5).trim()) + "</p>")
+}
+
+function theme (color) {
+  return ("<style>:root{--theme-color: " + color + ";}</style>")
+}
+
+function replaceVar (block) {
+  block.innerHTML = block.innerHTML.replace(/var\(\s*--theme-color.*?\)/g, __docsify__.themeColor);
+}
+
+function cssVars () {
+  // variable support
+  if (window.CSS && window.CSS.supports && window.CSS.supports('(--foo: red)')) { return }
+
+  var styleBlocks = document.querySelectorAll('style:not(.inserted),link');[].forEach.call(styleBlocks, function (block) {
+    if (block.nodeName === 'STYLE') {
+      replaceVar(block);
+    } else if (block.nodeName === 'LINK') {
+      load(block.getAttribute('href'))
+        .then(function (res) {
+          var style = document.createElement('style');
+
+          style.innerHTML = res;
+          document.head.appendChild(style);
+          replaceVar(style);
+        });
+    }
+  });
+}
+
+var markdown = marked;
+var toc = [];
 var CACHE = {};
 
 var renderTo = function (dom, content) {
   dom = typeof dom === 'object' ? dom : document.querySelector(dom);
   dom.innerHTML = content;
+  slugify.clear();
 
   return dom
 };
-var toc = [];
-var renderer = new marked.Renderer();
 
 /**
- * render anchor tag
- * @link https://github.com/chjj/marked#overriding-renderer-methods
+ * init render
  */
-renderer.heading = function (text, level) {
-  var slug = text.toLowerCase().replace(/<(?:.|\n)*?>/gm, '').replace(/[^\w|\u4e00-\u9fa5]+/g, '-');
-  var route = '';
+function init () {
+  var renderer = new marked.Renderer();
+  /**
+   * render anchor tag
+   * @link https://github.com/chjj/marked#overriding-renderer-methods
+   */
+  renderer.heading = function (text, level) {
+    var slug = slugify(text);
+    var route = '';
 
-  if (OPTIONS$1.router) {
     route = "#/" + (getRoute());
+    toc.push({ level: level, slug: (route + "#" + (encodeURIComponent(slug))), title: text });
+
+    return ("<h" + level + " id=\"" + slug + "\"><a href=\"" + route + "#" + slug + "\" data-id=\"" + slug + "\" class=\"anchor\"><span>" + text + "</span></a></h" + level + ">")
+  };
+  // highlight code
+  renderer.code = function (code, lang) {
+    if ( lang === void 0 ) lang = '';
+
+    var hl = prism.highlight(code, prism.languages[lang] || prism.languages.markup);
+
+    return ("<pre v-pre data-lang=\"" + lang + "\"><code class=\"lang-" + lang + "\">" + (hl.replace(/:/g, '__colon__')) + "</code></pre>")
+  };
+  renderer.link = function (href, title, text) {
+    if (!/:/.test(href)) {
+      href = ("#/" + href).replace(/\/\//g, '/');
+    }
+
+    return ("<a href=\"" + href + "\" title=\"" + (title || '') + "\">" + text + "</a>")
+  };
+  renderer.paragraph = function (text) {
+    if (/^!&gt;/.test(text)) {
+      return helper('tip', text)
+    } else if (/^\?&gt;/.test(text)) {
+      return helper('warn', text)
+    }
+    return ("<p>" + text + "</p>")
+  };
+
+  if (typeof __docsify__.markdown === 'function') {
+    markdown.setOptions({ renderer: renderer });
+    markdown = __docsify__.markdown.call(this, markdown);
+  } else {
+    markdown.setOptions(merge({ renderer: renderer }, __docsify__.markdown));
   }
 
-  toc.push({ level: level, slug: (route + "#" + slug), title: text });
+  var md = markdown;
 
-  return ("<h" + level + " id=\"" + slug + "\"><a href=\"" + route + "#" + slug + "\" class=\"anchor\"></a>" + text + "</h" + level + ">")
-};
-// highlight code
-renderer.code = function (code, lang) {
-  if ( lang === void 0 ) lang = '';
-
-  var hl = prism.highlight(code, prism.languages[lang] || prism.languages.markup);
-
-  return ("<pre data-lang=\"" + lang + "\"><code class=\"lang-" + lang + "\">" + hl + "</code></pre>")
-};
-renderer.link = function (href, title, text) {
-  if (OPTIONS$1.router && !/^(?:\w+:)?\/\/([^\s\.]+\.\S{2}|localhost[\:?\d]*)\S*$/.test(href)) {
-    href = !/^\/#/.test(href) ? ("#" + href) : href;
-  }
-
-  return ("<a href=\"" + href + "\" title=\"" + (title || '') + "\">" + text + "</a>")
-};
-marked.setOptions({ renderer: renderer });
+  markdown = function (text) { return emojify(md(text)); };
+}
 
 /**
  * App
@@ -2402,35 +2593,62 @@ 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 (!__docsify__.repo) { nav.classList.add('no-badge'); }
+
+  dom[replace ? 'outerHTML' : 'innerHTML'] = corner(__docsify__.repo) +
+    (__docsify__.coverpage ? cover() : '') +
+    main();
   document.body.insertBefore(nav, document.body.children[0]);
 
+  // theme color
+  if (__docsify__.themeColor) {
+    document.head.innerHTML += theme(__docsify__.themeColor);
+    cssVars();
+  }
+
   // bind toggle
   bindToggle('button.sidebar-toggle');
+  // bind sticky effect
+  if (__docsify__.coverpage) {
+    !isMobile() && window.addEventListener('scroll', sticky);
+  } else {
+    document.body.classList.add('sticky');
+  }
 }
 
 /**
  * article
  */
 function renderArticle (content) {
-  renderTo('article', content ? marked(content) : 'not found');
-  if (!renderSidebar.rendered) { renderSidebar(null, OPTIONS$1); }
-  if (!renderNavbar.rendered) { renderNavbar(null, OPTIONS$1); }
-  renderSidebar.rendered = false;
-  renderNavbar.rendered = false;
+  renderTo('article', content ? markdown(content) : 'not found');
+  if (!__docsify__.loadSidebar) { renderSidebar(); }
 
-  if (OPTIONS$1.auto2top) { scroll2Top(); }
+  if (content && typeof Vue !== 'undefined') {
+    CACHE.vm && CACHE.vm.$destroy();
+
+    var script = [].slice.call(
+      document.body.querySelectorAll('article>script'))
+        .filter(function (script) { return !/template/.test(script.type); }
+      )[0];
+    var code = script ? script.innerText.trim() : null;
+
+    script && script.remove();
+    CACHE.vm = code
+      ? new Function(("return " + code))()
+      : new Vue({ el: 'main' }); // eslint-disable-line
+    CACHE.vm && CACHE.vm.$nextTick(function (_) { return scrollActiveSidebar(); });
+  }
+  if (__docsify__.auto2top) { setTimeout(function () { return scroll2Top(__docsify__.auto2top); }, 0); }
 }
 
 /**
  * navbar
  */
 function renderNavbar (content) {
-  if (CACHE['navbar'] && CACHE['navbar'] === content) { return }
-  CACHE['navbar'] = content;
-  renderNavbar.rendered = true;
+  if (CACHE.navbar && CACHE.navbar === content) { return }
+  CACHE.navbar = content;
 
-  if (content) { renderTo('nav', marked(content)); }
+  if (content) { renderTo('nav', markdown(content)); }
   activeLink('nav');
 }
 
@@ -2438,23 +2656,66 @@ function renderNavbar (content) {
  * sidebar
  */
 function renderSidebar (content) {
-  var isToc = false;
+  var html;
 
   if (content) {
-    content = marked(content);
-  } else if (OPTIONS$1.sidebar) {
-    content = tree(OPTIONS$1.sidebar, '<ul>');
+    html = markdown(content);
+    // find url tag
+    html = html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0];
   } else {
-    content = tree(genTree(toc, OPTIONS$1.maxLevel), '<ul>');
-    isToc = true;
+    html = tree(genTree(toc, __docsify__.maxLevel), '<ul>');
   }
 
-  renderSidebar.rendered = true;
-  if (CACHE['sidebar'] && CACHE['sidebar'] === content) { return }
-  CACHE['sidebar'] = content;
-  renderTo('aside.sidebar', content);
-  if (isToc) { scrollActiveSidebar(); }
+  html = (__docsify__.name ? ("<h1><a href=\"" + (__docsify__.nameLink) + "\">" + (__docsify__.name) + "</a></h1>") : '') + html;
+  renderTo('aside.sidebar', html);
+  var target = activeLink('aside.sidebar', true);
+  if (target) { renderSubSidebar(target); }
   toc = [];
+
+  scrollActiveSidebar();
+}
+
+function renderSubSidebar (target) {
+  if (!__docsify__.subMaxLevel) { return }
+  target.parentNode.innerHTML += tree(genTree(toc, __docsify__.subMaxLevel), '<ul>');
+}
+
+/**
+ * Cover Page
+ */
+function renderCover (content) {
+  renderCover.dom = renderCover.dom || document.querySelector('section.cover');
+  if (!content) {
+    renderCover.dom.classList.remove('show');
+    return
+  }
+  renderCover.dom.classList.add('show');
+  if (renderCover.rendered) { return sticky() }
+
+  // render cover
+  var cacheToc = toc.slice();
+  var html = markdown(content);
+  var match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)">([^<]*?)</p>$');
+
+  toc = cacheToc.slice();
+
+  // render background
+  if (match) {
+    var coverEl = document.querySelector('section.cover');
+
+    if (match[2] === 'color') {
+      coverEl.style.background = match[1] + (match[3] || '');
+    } else {
+      coverEl.classList.add('has-mask');
+      coverEl.style.backgroundImage = "url(" + (match[1]) + ")";
+    }
+    html = html.replace(match[0], '');
+  }
+
+  renderTo('.cover-main', html);
+  renderCover.rendered = true;
+
+  sticky();
 }
 
 /**
@@ -2464,49 +2725,51 @@ 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']) {
+  if (!CACHE.loading) {
     var div = document.createElement('div');
 
     div.classList.add('progress');
     document.body.appendChild(div);
-    CACHE['loading'] = 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);
-    CACHE['loading'].style.width = '100%';
-    renderLoading.cacheTImeout = setTimeout(function (_) {
-      CACHE['loading'].style.opacity = 0;
-      CACHE['loading'].style.width = '0%';
+    clearTimeout(renderLoading.cacheTimeout);
+    renderLoading.cacheTimeout = setTimeout(function (_) {
+      CACHE.loading.style.opacity = 0;
+      CACHE.loading.style.width = '0%';
     }, 200);
-  } else {
-    CACHE['loading'].style.opacity = 1;
-    CACHE['loading'].style.width = num + '%';
   }
 }
 
-/**
- * Load Config
- * @param  {Object} options
- */
-function config (options) {
-  OPTIONS$1 = options;
-}
-
-var OPTIONS = {
+var OPTIONS = merge({
   el: '#app',
   repo: '',
   maxLevel: 6,
-  sidebar: '',
-  sidebarToggle: false,
+  subMaxLevel: 0,
   loadSidebar: null,
   loadNavbar: null,
-  router: false,
-  auto2top: false
-};
+  homepage: 'README.md',
+  coverpage: '',
+  basePath: '',
+  auto2top: false,
+  name: '',
+  themeColor: '',
+  nameLink: window.location.pathname
+}, window.$docsify);
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();
 
 // load configuration for script attribute
@@ -2517,19 +2780,24 @@ if (script) {
   }
   if (OPTIONS.loadSidebar === true) { OPTIONS.loadSidebar = '_sidebar.md'; }
   if (OPTIONS.loadNavbar === true) { OPTIONS.loadNavbar = '_navbar.md'; }
-  if (OPTIONS.sidebar) { OPTIONS.sidebar = window[OPTIONS.sidebar]; }
+  if (OPTIONS.coverpage === true) { OPTIONS.coverpage = '_coverpage.md'; }
+  if (OPTIONS.repo === true) { OPTIONS.repo = ''; }
+  if (OPTIONS.name === true) { OPTIONS.name = ''; }
 }
 
+// utils
+window.__docsify__ = OPTIONS;
+
 // load options
-config(OPTIONS);
+init(OPTIONS);
 
 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;
 
   if (!/\//.test(basePath)) {
@@ -2538,35 +2806,42 @@ 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 && page === OPTIONS.homepage) {
+    load(OPTIONS.coverpage).then(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);
+    // clear cover
+    if (OPTIONS.coverpage && page !== OPTIONS.homepage) { renderCover(); }
+    // render sidebar
     if (OPTIONS.loadSidebar) {
-      if (wait === false) { cb(); }
-      wait = false;
+      var renderSidebar$$1 = function (result) { renderSidebar(result); cb(); };
+
+      load(basePath + OPTIONS.loadSidebar).then(renderSidebar$$1,
+        function (_) { return load(OPTIONS.loadSidebar).then(renderSidebar$$1); });
     } else {
       cb();
     }
   }, function (_) { return renderArticle(null); });
 
-  // Render sidebar
-  if (OPTIONS.loadSidebar) {
-    load(basePath + OPTIONS.loadSidebar).then(function (result) {
-      renderSidebar(result);
-      if (wait === false) { cb(); }
-      wait = false;
-    });
-  }
-
   // Render navbar
   if (OPTIONS.loadNavbar) {
-    load(basePath + OPTIONS.loadNavbar).then(renderNavbar);
+    load(basePath + OPTIONS.loadNavbar).then(renderNavbar,
+      function (_) { return load(OPTIONS.loadNavbar).then(renderNavbar); });
   }
 };
 
@@ -2575,18 +2850,16 @@ var Docsify = function () {
   var replace = dom !== document.body;
   var main = function () {
     mainRender(function (_) {
-      activeLink('aside.sidebar', true);
       scrollIntoView();
+      activeLink('nav');
     });
   };
 
   // Render app
   renderApp(dom, replace);
   main();
-  if (OPTIONS.router) {
-    if (!/^#\//.test(window.location.hash)) { window.location.hash = '#/'; }
-    window.addEventListener('hashchange', main);
-  }
+  if (!/^#\//.test(window.location.hash)) { window.location.hash = '#/'; }
+  window.addEventListener('hashchange', main);
 };
 
 var index = Docsify();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "1.1.2",
+  "version": "2.0.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": {
@@ -35,9 +35,9 @@
     "nodemon": "^1.11.0",
     "postcss": "^5.2.6",
     "postcss-salad": "^1.0.5",
-    "rollup": "^0.36.3",
-    "rollup-plugin-buble": "^0.14.0",
-    "rollup-plugin-commonjs": "^5.0.5",
+    "rollup": "^0.41.1",
+    "rollup-plugin-buble": "^0.15.0",
+    "rollup-plugin-commonjs": "^7.0.0",
     "rollup-plugin-node-resolve": "^2.0.0",
     "rollup-plugin-uglify": "^1.0.1",
     "serve-static": "^1.11.1"

src/event.js

@@ -7,51 +7,84 @@ import { isMobile } from './util'
 export function scrollActiveSidebar () {
   if (isMobile()) return
 
+  let hoveredOverSidebar = false
   const anchors = document.querySelectorAll('.anchor')
+  const sidebar = document.querySelector('aside.sidebar')
+  const sidebarHeight = sidebar.clientHeight
+
   const nav = {}
-  const lis = document.querySelectorAll('.sidebar li')
-  let active = null
+  const lis = sidebar.querySelectorAll('li')
+  let active = sidebar.querySelector('li.active')
 
   for (let i = 0, len = lis.length; i < len; i += 1) {
     const li = lis[i]
     let href = li.querySelector('a').getAttribute('href')
 
-    if (href !== '/') href = href.match(/#([^#]+)$/g)[0].slice(1)
+    if (href !== '/') {
+      const match = href.match('#([^#]+)$')
+      if (match && match.length) href = match[0].slice(1)
+    }
 
-    nav[href] = li
+    nav[decodeURIComponent(href)] = li
   }
 
   function highlight () {
+    const top = document.body.scrollTop
+    let last
+
     for (let i = 0, len = anchors.length; i < len; i += 1) {
-      const node = anchors[i].parentNode
-      const bcr = node.getBoundingClientRect()
+      const node = anchors[i]
 
-      if (bcr.top < 10 && bcr.bottom > 10) {
-        const li = nav[node.id]
-
-        if (!li || li === active) return
-        if (active) active.setAttribute('class', '')
-
-        li.setAttribute('class', 'active')
-        active = li
-
-        return
+      if (node.offsetTop > top) {
+        if (!last) last = node
+        break
+      } else {
+        last = node
       }
     }
+    if (!last) return
+    const li = nav[last.getAttribute('data-id')]
+
+    if (!li || li === active) return
+    if (active) active.classList.remove('active')
+
+    li.classList.add('active')
+    active = li
+
+    // scroll into view
+    // https://github.com/vuejs/vuejs.org/blob/master/themes/vue/source/js/common.js#L282-L297
+    if (!hoveredOverSidebar && !sticky.noSticky) {
+      const currentPageOffset = 0
+      const currentActiveOffset = active.offsetTop + active.clientHeight + 40
+      const currentActiveIsInView = (
+        active.offsetTop >= sidebar.scrollTop &&
+        currentActiveOffset <= sidebar.scrollTop + sidebarHeight
+      )
+      const linkNotFurtherThanSidebarHeight = currentActiveOffset - currentPageOffset < sidebarHeight
+      const newScrollTop = currentActiveIsInView
+        ? sidebar.scrollTop
+        : linkNotFurtherThanSidebarHeight
+          ? currentPageOffset
+          : currentActiveOffset - sidebarHeight
+
+      sidebar.scrollTop = newScrollTop
+    }
   }
 
-  const dom = document.querySelector('main .content')
-  dom.removeEventListener('scroll', highlight)
-  dom.addEventListener('scroll', highlight)
-  highlight()
+  window.removeEventListener('scroll', highlight)
+  window.addEventListener('scroll', highlight)
+  sidebar.addEventListener('mouseover', () => { hoveredOverSidebar = true })
+  sidebar.addEventListener('mouseleave', () => { hoveredOverSidebar = false })
 }
 
 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()
+  if (section) setTimeout(() => section.scrollIntoView(), 0)
+
+  return section
 }
 
 /**
@@ -62,18 +95,24 @@ export function activeLink (dom, activeParent) {
 
   dom = typeof dom === 'object' ? dom : document.querySelector(dom)
   if (!dom) return
+  let target
 
-  ;[].slice.call(dom.querySelectorAll('a')).forEach(node => {
-    if (node.href === host) {
-      activeParent
-        ? node.parentNode.setAttribute('class', 'active')
-        : node.setAttribute('class', 'active')
-    } else {
-      activeParent
-        ? node.parentNode.removeAttribute('class')
-        : node.removeAttribute('class')
-    }
-  })
+  ;[].slice.call(dom.querySelectorAll('a'))
+    .sort((a, b) => b.href.length - a.href.length)
+    .forEach(node => {
+      if (host.indexOf(node.href) === 0 && !target) {
+        activeParent
+          ? node.parentNode.classList.add('active')
+          : node.classList.add('active')
+        target = node
+      } else {
+        activeParent
+          ? node.parentNode.classList.remove('active')
+          : node.classList.remove('active')
+      }
+    })
+
+  return target
 }
 
 /**
@@ -86,17 +125,30 @@ export function bindToggle (dom) {
 
   dom.addEventListener('click', () => body.classList.toggle('close'))
 
-  if (!/mobile/i.test(navigator.userAgent)) return
-  document.querySelector('aside').addEventListener('click', event => {
-    body.classList.toggle('close')
-  })
+  if (isMobile()) {
+    const sidebar = document.querySelector('aside.sidebar')
+    sidebar.addEventListener('click', () => {
+      body.classList.toggle('close')
+      setTimeout(() => activeLink(sidebar, true), 0)
+    })
+  }
 }
 
-let cacheContentDOM
-export function scroll2Top () {
-  if (!cacheContentDOM) {
-    const dom = isMobile() ? 'body' : 'section.content'
-    cacheContentDOM = document.querySelector(dom)
-  }
-  cacheContentDOM.scrollTop = 0
+export function scroll2Top (offset = 0) {
+  document.body.scrollTop = offset === true ? 0 : Number(offset)
+}
+
+export function sticky () {
+  sticky.dom = sticky.dom || document.querySelector('section.cover')
+  const coverHeight = sticky.dom.getBoundingClientRect().height
+
+  return (function () {
+    if (window.pageYOffset >= coverHeight || sticky.dom.classList.contains('hidden')) {
+      document.body.classList.add('sticky')
+      sticky.noSticky = false
+    } else {
+      document.body.classList.remove('sticky')
+      sticky.noSticky = true
+    }
+  })()
 }

src/index.js

@@ -1,18 +1,22 @@
-import { load, camel2kebab, isNil, getRoute } from './util'
-import { activeLink, scrollIntoView } from './event'
+import { load, camel2kebab, isNil, getRoute, merge } from './util'
+import { scrollIntoView, activeLink } from './event'
 import * as render from './render'
 
-const OPTIONS = {
+const OPTIONS = merge({
   el: '#app',
   repo: '',
   maxLevel: 6,
-  sidebar: '',
-  sidebarToggle: false,
+  subMaxLevel: 0,
   loadSidebar: null,
   loadNavbar: null,
-  router: false,
-  auto2top: false
-}
+  homepage: 'README.md',
+  coverpage: '',
+  basePath: '',
+  auto2top: false,
+  name: '',
+  themeColor: '',
+  nameLink: window.location.pathname
+}, window.$docsify)
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()
 
 // load configuration for script attribute
@@ -23,19 +27,24 @@ if (script) {
   }
   if (OPTIONS.loadSidebar === true) OPTIONS.loadSidebar = '_sidebar.md'
   if (OPTIONS.loadNavbar === true) OPTIONS.loadNavbar = '_navbar.md'
-  if (OPTIONS.sidebar) OPTIONS.sidebar = window[OPTIONS.sidebar]
+  if (OPTIONS.coverpage === true) OPTIONS.coverpage = '_coverpage.md'
+  if (OPTIONS.repo === true) OPTIONS.repo = ''
+  if (OPTIONS.name === true) OPTIONS.name = ''
 }
 
+// utils
+window.__docsify__ = OPTIONS
+
 // load options
-render.config(OPTIONS)
+render.init(OPTIONS)
 
 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
 
   if (!/\//.test(basePath)) {
@@ -44,35 +53,42 @@ 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 && page === OPTIONS.homepage) {
+    load(OPTIONS.coverpage).then(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)
+    // clear cover
+    if (OPTIONS.coverpage && page !== OPTIONS.homepage) render.renderCover()
+    // render sidebar
     if (OPTIONS.loadSidebar) {
-      if (wait === false) cb()
-      wait = false
+      const renderSidebar = result => { render.renderSidebar(result); cb() }
+
+      load(basePath + OPTIONS.loadSidebar).then(renderSidebar,
+        _ => load(OPTIONS.loadSidebar).then(renderSidebar))
     } else {
       cb()
     }
   }, _ => render.renderArticle(null))
 
-  // Render sidebar
-  if (OPTIONS.loadSidebar) {
-    load(basePath + OPTIONS.loadSidebar).then(result => {
-      render.renderSidebar(result)
-      if (wait === false) cb()
-      wait = false
-    })
-  }
-
   // Render navbar
   if (OPTIONS.loadNavbar) {
-    load(basePath + OPTIONS.loadNavbar).then(render.renderNavbar)
+    load(basePath + OPTIONS.loadNavbar).then(render.renderNavbar,
+      _ => load(OPTIONS.loadNavbar).then(render.renderNavbar))
   }
 }
 
@@ -81,18 +97,16 @@ const Docsify = function () {
   const replace = dom !== document.body
   const main = function () {
     mainRender(_ => {
-      activeLink('aside.sidebar', true)
       scrollIntoView()
+      activeLink('nav')
     })
   }
 
   // Render app
   render.renderApp(dom, replace)
   main()
-  if (OPTIONS.router) {
-    if (!/^#\//.test(window.location.hash)) window.location.hash = '#/'
-    window.addEventListener('hashchange', main)
-  }
+  if (!/^#\//.test(window.location.hash)) window.location.hash = '#/'
+  window.addEventListener('hashchange', main)
 }
 
 export default Docsify()

src/polyfill.js

@@ -0,0 +1,27 @@
+import { load } from './util'
+
+function replaceVar (block) {
+  block.innerHTML = block.innerHTML.replace(/var\(\s*--theme-color.*?\)/g, __docsify__.themeColor)
+}
+
+export function cssVars () {
+  // variable support
+  if (window.CSS && window.CSS.supports && window.CSS.supports('(--foo: red)')) return
+
+  const styleBlocks = document.querySelectorAll('style:not(.inserted),link')
+
+  ;[].forEach.call(styleBlocks, block => {
+    if (block.nodeName === 'STYLE') {
+      replaceVar(block)
+    } else if (block.nodeName === 'LINK') {
+      load(block.getAttribute('href'))
+        .then(res => {
+          const style = document.createElement('style')
+
+          style.innerHTML = res
+          document.head.appendChild(style)
+          replaceVar(style)
+        })
+    }
+  })
+}

src/render.js

@@ -1,51 +1,73 @@
 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 * as event from './event'
+import * as polyfill from './polyfill'
+import { genTree, getRoute, isMobile, slugify, merge, emojify } from './util'
 
-let OPTIONS = {}
+let markdown = marked
+let toc = []
 const CACHE = {}
 
 const renderTo = function (dom, content) {
   dom = typeof dom === 'object' ? dom : document.querySelector(dom)
   dom.innerHTML = content
+  slugify.clear()
 
   return dom
 }
-let toc = []
-const renderer = new marked.Renderer()
 
 /**
- * render anchor tag
- * @link https://github.com/chjj/marked#overriding-renderer-methods
+ * init render
  */
-renderer.heading = function (text, level) {
-  const slug = text.toLowerCase().replace(/<(?:.|\n)*?>/gm, '').replace(/[^\w|\u4e00-\u9fa5]+/g, '-')
-  let route = ''
+export function init () {
+  const renderer = new marked.Renderer()
+  /**
+   * render anchor tag
+   * @link https://github.com/chjj/marked#overriding-renderer-methods
+   */
+  renderer.heading = function (text, level) {
+    const slug = slugify(text)
+    let route = ''
 
-  if (OPTIONS.router) {
     route = `#/${getRoute()}`
+    toc.push({ level, slug: `${route}#${encodeURIComponent(slug)}`, title: text })
+
+    return `<h${level} id="${slug}"><a href="${route}#${slug}" data-id="${slug}" class="anchor"><span>${text}</span></a></h${level}>`
+  }
+  // highlight code
+  renderer.code = function (code, lang = '') {
+    const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
+
+    return `<pre v-pre data-lang="${lang}"><code class="lang-${lang}">${hl.replace(/:/g, '__colon__')}</code></pre>`
+  }
+  renderer.link = function (href, title, text) {
+    if (!/:/.test(href)) {
+      href = `#/${href}`.replace(/\/\//g, '/')
+    }
+
+    return `<a href="${href}" title="${title || ''}">${text}</a>`
+  }
+  renderer.paragraph = function (text) {
+    if (/^!&gt;/.test(text)) {
+      return tpl.helper('tip', text)
+    } else if (/^\?&gt;/.test(text)) {
+      return tpl.helper('warn', text)
+    }
+    return `<p>${text}</p>`
   }
 
-  toc.push({ level, slug: `${route}#${slug}`, title: text })
-
-  return `<h${level} id="${slug}"><a href="${route}#${slug}" class="anchor"></a>${text}</h${level}>`
-}
-// highlight code
-renderer.code = function (code, lang = '') {
-  const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
-
-  return `<pre data-lang="${lang}"><code class="lang-${lang}">${hl}</code></pre>`
-}
-renderer.link = function (href, title, text) {
-  if (OPTIONS.router && !/^(?:\w+:)?\/\/([^\s\.]+\.\S{2}|localhost[\:?\d]*)\S*$/.test(href)) {
-    href = !/^\/#/.test(href) ? `#${href}` : href
+  if (typeof __docsify__.markdown === 'function') {
+    markdown.setOptions({ renderer })
+    markdown = __docsify__.markdown.call(this, markdown)
+  } else {
+    markdown.setOptions(merge({ renderer }, __docsify__.markdown))
   }
 
-  return `<a href="${href}" title="${title || ''}">${text}</a>`
+  const md = markdown
+
+  markdown = text => emojify(md(text))
 }
-marked.setOptions({ renderer })
 
 /**
  * App
@@ -53,94 +75,160 @@ 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 (!__docsify__.repo) nav.classList.add('no-badge')
+
+  dom[replace ? 'outerHTML' : 'innerHTML'] = tpl.corner(__docsify__.repo) +
+    (__docsify__.coverpage ? tpl.cover() : '') +
+    tpl.main()
   document.body.insertBefore(nav, document.body.children[0])
 
+  // theme color
+  if (__docsify__.themeColor) {
+    document.head.innerHTML += tpl.theme(__docsify__.themeColor)
+    polyfill.cssVars()
+  }
+
   // bind toggle
-  bindToggle('button.sidebar-toggle')
+  event.bindToggle('button.sidebar-toggle')
+  // bind sticky effect
+  if (__docsify__.coverpage) {
+    !isMobile() && window.addEventListener('scroll', event.sticky)
+  } else {
+    document.body.classList.add('sticky')
+  }
 }
 
 /**
  * article
  */
 export function renderArticle (content) {
-  renderTo('article', content ? marked(content) : 'not found')
-  if (!renderSidebar.rendered) renderSidebar(null, OPTIONS)
-  if (!renderNavbar.rendered) renderNavbar(null, OPTIONS)
-  renderSidebar.rendered = false
-  renderNavbar.rendered = false
+  renderTo('article', content ? markdown(content) : 'not found')
+  if (!__docsify__.loadSidebar) renderSidebar()
 
-  if (OPTIONS.auto2top) scroll2Top()
+  if (content && typeof Vue !== 'undefined') {
+    CACHE.vm && CACHE.vm.$destroy()
+
+    const script = [].slice.call(
+      document.body.querySelectorAll('article>script'))
+        .filter(script => !/template/.test(script.type)
+      )[0]
+    const code = script ? script.innerText.trim() : null
+
+    script && script.remove()
+    CACHE.vm = code
+      ? new Function(`return ${code}`)()
+      : new Vue({ el: 'main' }) // eslint-disable-line
+    CACHE.vm && CACHE.vm.$nextTick(_ => event.scrollActiveSidebar())
+  }
+  if (__docsify__.auto2top) setTimeout(() => event.scroll2Top(__docsify__.auto2top), 0)
 }
 
 /**
  * navbar
  */
 export function renderNavbar (content) {
-  if (CACHE['navbar'] && CACHE['navbar'] === content) return
-  CACHE['navbar'] = content
-  renderNavbar.rendered = true
+  if (CACHE.navbar && CACHE.navbar === content) return
+  CACHE.navbar = content
 
-  if (content) renderTo('nav', marked(content))
-  activeLink('nav')
+  if (content) renderTo('nav', markdown(content))
+  event.activeLink('nav')
 }
 
 /**
  * sidebar
  */
 export function renderSidebar (content) {
-  let isToc = false
+  let html
 
   if (content) {
-    content = marked(content)
-  } else if (OPTIONS.sidebar) {
-    content = tpl.tree(OPTIONS.sidebar, '<ul>')
+    html = markdown(content)
+    // find url tag
+    html = html.match(/<ul[^>]*>([\s\S]+)<\/ul>/g)[0]
   } else {
-    content = tpl.tree(genTree(toc, OPTIONS.maxLevel), '<ul>')
-    isToc = true
+    html = tpl.tree(genTree(toc, __docsify__.maxLevel), '<ul>')
   }
 
-  renderSidebar.rendered = true
-  if (CACHE['sidebar'] && CACHE['sidebar'] === content) return
-  CACHE['sidebar'] = content
-  renderTo('aside.sidebar', content)
-  if (isToc) scrollActiveSidebar()
+  html = (__docsify__.name ? `<h1><a href="${__docsify__.nameLink}">${__docsify__.name}</a></h1>` : '') + html
+  renderTo('aside.sidebar', html)
+  const target = event.activeLink('aside.sidebar', true)
+  if (target) renderSubSidebar(target)
   toc = []
+
+  event.scrollActiveSidebar()
+}
+
+export function renderSubSidebar (target) {
+  if (!__docsify__.subMaxLevel) return
+  target.parentNode.innerHTML += tpl.tree(genTree(toc, __docsify__.subMaxLevel), '<ul>')
+}
+
+/**
+ * Cover Page
+ */
+export function renderCover (content) {
+  renderCover.dom = renderCover.dom || document.querySelector('section.cover')
+  if (!content) {
+    renderCover.dom.classList.remove('show')
+    return
+  }
+  renderCover.dom.classList.add('show')
+  if (renderCover.rendered) return event.sticky()
+
+  // render cover
+  const cacheToc = toc.slice()
+  let html = markdown(content)
+  const match = html.trim().match('<p><img[^s]+src="(.*?)"[^a]+alt="(.*?)">([^<]*?)</p>$')
+
+  toc = cacheToc.slice()
+
+  // render background
+  if (match) {
+    const coverEl = document.querySelector('section.cover')
+
+    if (match[2] === 'color') {
+      coverEl.style.background = match[1] + (match[3] || '')
+    } else {
+      coverEl.classList.add('has-mask')
+      coverEl.style.backgroundImage = `url(${match[1]})`
+    }
+    html = html.replace(match[0], '')
+  }
+
+  renderTo('.cover-main', html)
+  renderCover.rendered = true
+
+  event.sticky()
 }
 
 /**
  * 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']) {
+  if (!CACHE.loading) {
     const div = document.createElement('div')
 
     div.classList.add('progress')
     document.body.appendChild(div)
-    CACHE['loading'] = 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)
-    CACHE['loading'].style.width = '100%'
-    renderLoading.cacheTImeout = setTimeout(_ => {
-      CACHE['loading'].style.opacity = 0
-      CACHE['loading'].style.width = '0%'
+    clearTimeout(renderLoading.cacheTimeout)
+    renderLoading.cacheTimeout = setTimeout(_ => {
+      CACHE.loading.style.opacity = 0
+      CACHE.loading.style.width = '0%'
     }, 200)
-  } else {
-    CACHE['loading'].style.opacity = 1
-    CACHE['loading'].style.width = num + '%'
   }
 }
-
-/**
- * Load Config
- * @param  {Object} options
- */
-export function config (options) {
-  OPTIONS = options
-}
-

src/themes/basic/_coverpage.css

@@ -0,0 +1,103 @@
+section.cover {
+  align-items: center;
+  background-position: center center;
+  background-repeat: no-repeat;
+  background-size: cover;
+  height: 100vh;
+  display: none;
+
+  &.show {
+    display: flex;
+  }
+
+  &.has-mask .mask {
+    position: absolute;
+    size: 100%;
+    background-color: $color-bg;
+    opacity: .8;
+  }
+
+  .cover-main {
+    flex: 1;
+    text-align: center;
+    margin: -20px 16px 0;
+    z-index: 1;
+  }
+
+  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;
+
+    a {
+      display: block;
+    }
+
+    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-width: 1px;
+    border-style: solid;
+    border-color: var(--theme-color, $color-primary);
+    box-sizing: border-box;
+    color: var(--theme-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: var(--theme-color, $color-primary);
+      color: #fff;
+
+      &:hover {
+        opacity: .8;
+        color: inherit;
+      }
+    }
+
+    &:hover {
+      color: inherit;
+    }
+  }
+}

src/themes/basic/_layout.css

@@ -1,4 +1,3 @@
-
 * {
   box-sizing: border-box;
   -webkit-overflow-scrolling: touch;
@@ -8,8 +7,13 @@
   -webkit-font-smoothing: antialiased;
 }
 
+.emoji {
+  height: 1.2em;
+  vertical-align: middle;
+}
+
 .progress {
-  background-color: $color-primary;
+  background-color: var(--theme-color, $color-primary);
   height: 2px;
   left: 0px;
   position: fixed;
@@ -32,12 +36,24 @@ body {
   letter-spacing: 0;
   margin: 0;
   overflow-x: hidden;
+  color: $color-text;
 }
 
 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 +63,10 @@ nav {
   margin: 25px 60px 0 0;
   text-align: right;
 
+  &.no-badge {
+    margin-right: 25px;
+  }
+
   p {
     margin: 0;
   }
@@ -66,12 +86,12 @@ nav {
     transition: color .3s;
 
     &:hover {
-      color: $color-primary;
+      color: var(--theme-color, $color-primary);
     }
 
     &.active {
-      color: $color-primary;
-      border-bottom: 2px solid $color-primary;
+      color: var(--theme-color, $color-primary);
+      border-bottom: 2px solid var(--theme-color, $color-primary);
     }
   }
 
@@ -81,8 +101,11 @@ nav {
     display: inline-block;
 
     ul {
-      background-color: rgba(#fff, .6);
-      border: 1px solid $color-primary;
+      border-radius: 2px;
+      background-color: rgba($color-bg, .6);
+      border-width: 1px;
+      border-style: solid;
+      border-color: var(--theme-color, $color-primary);
       opacity: 0;
       overflow: hidden;
       padding: 0;
@@ -124,45 +147,67 @@ 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;
   }
 
   svg {
-    color: #fff;
+    color: $color-bg;
     height: 80px;
     width: 80px;
-    fill: $color-primary;
+    fill: var(--theme-color, $color-primary);
   }
 }
 
 /* main */
 main {
-  size: 100% 100%;
+  display: block;
+  size: 100vw 100%;
   position: relative;
 }
 
+.anchor {
+  text-decoration: none;
+  transition: all .3s;
+  display: inline-block;
+
+  span {
+    color: $color-text;
+  }
+
+  &:hover {
+    text-decoration: underline;
+  }
+}
+
 /* sidebar */
 .sidebar {
-  border-right: 1px solid rgba(0, 0, 0, .07);
   overflow-y: auto;
-  padding-top: 40px;
+  padding: 40px 0;
   position: absolute 0 * 0 0;
   transition: transform 250ms ease-out;
   width: $sidebar-width;
   z-index: 20;
+  border-right: 1px solid rgba(0, 0, 0, .07);
+
+  > h1 {
+    text-align: center;
+    margin: 0 auto 1em;
+    font-size: 1.5em;
+    font-weight: 300;
+
+    a {
+      color: inherit;
+      text-decoration: none;
+    }
+  }
 
   ul {
     margin: 0;
@@ -187,33 +232,38 @@ main {
 .sidebar-toggle {
   background-color: transparent;
   border: 0;
-  bottom: 10px;
-  left: 10px;
   outline: none;
-  position: absolute;
+  position: absolute * * 0 0;
   text-align: center;
   transition: opacity .3s;
   width: 30px;
   z-index: 30;
   outline: none;
+  width: calc($sidebar-width - 16px);
+  padding: 10px;
+  background-color: rgba($color-bg, .8);
 
-  &:hover {
+  .sidebar-toggle-button:hover {
     opacity: .4;
   }
 
   span {
-    background-color: $color-primary;
+    background-color: var(--theme-color, $color-primary);
     display: block;
     size: 16px 2px;
     margin-bottom: 4px;
   }
 }
 
+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,18 +285,95 @@ main {
   }
 }
 
+.markdown-section hr {
+  border: none;
+  margin: 2em 0;
+  border-bottom: 1px solid #eee;
+}
+
+.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;
+  }
+}
+
+.markdown-section p.tip {
+  padding: 12px 24px 12px 30px;
+  margin: 2em 0;
+  border-left: 4px solid #f66;
+  background-color: #f8f8f8;
+  position: relative;
+  border-bottom-right-radius: 2px;
+  border-top-right-radius: 2px;
+
+  &:before {
+    position: absolute;
+    top: 14px;
+    left: -12px;
+    background-color: #f66;
+    color: $color-bg;
+    content: "!";
+    size: 20px;
+    border-radius: 100%;
+    text-align: center;
+    line-height: 20px;
+    font-weight: bold;
+    font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
+    font-size: 14px;
+  }
+
+  code {
+    background-color: #efefef;
+  }
+
+  em {
+    color: $color-text;
+  }
+}
+
+.markdown-section p.warn {
+  padding: 1em;
+  background: rgba($color-primary, 0.1);
+  border-radius: 2px;
+}
+
 body.close {
   .sidebar {
     transform: translateX(-$sidebar-width);
   }
 
+  .sidebar-toggle {
+    width: auto;
+  }
+
   .content {
     left: 0;
   }
 }
 
 @media (max-width: 600px) {
-  nav, .github-corner, .sidebar-toggle, .sidebar {
+  .github-corner, .sidebar-toggle, .sidebar {
     position: fixed;
   }
 
@@ -258,6 +385,11 @@ body.close {
     top: 30px;
   }
 
+  main {
+    height: auto;
+    overflow-x: hidden;
+  }
+
   .sidebar {
     left: -$sidebar-width;
     transition: transform 250ms ease-out;
@@ -265,27 +397,37 @@ body.close {
 
   .content {
     left: 0;
-    min-width: 100vw;
-    transition: transform 250ms ease;
+    max-width: 100vw;
     position: static;
-    overflow-y: auto;
+    transition: transform 250ms ease;
   }
 
   nav, .github-corner {
     transition: transform 250ms ease-out;
   }
 
+  .sidebar-toggle {
+    width: auto;
+    background-color: transparent;
+  }
+
   body.close {
     .sidebar {
       transform: translateX($sidebar-width);
     }
 
+    .sidebar-toggle {
+      width: calc($sidebar-width - 16px);
+      background-color: rgba($color-bg, .8);
+      transition: 1s background-color;
+    }
+
     .content {
       transform: translateX($sidebar-width);
     }
 
     nav, .github-corner {
-      transform: translateX($sidebar-width);
+      display: none;
     }
   }
 

src/themes/buble.css

@@ -1,16 +1,17 @@
 @import url('https://fonts.googleapis.com/css?family=Inconsolata|Inconsolata-Bold');
 
 $color-primary: #0074D9;
+$color-bg: #fff;
+$color-text: #34495e;
 $sidebar-width: 16em;
 
 @import "basic/layout";
+@import "basic/coverpage";
 
-body {
-  color: #34495e;
-}
 /* sidebar */
 .sidebar {
   color: #364149;
+  background-color: $color-bg;
 
   a {
     color: #666;
@@ -27,7 +28,7 @@ body {
     padding: 0;
   }
 
-  .active {
+  li.active {
     background-color: #eee;
 
     a {
@@ -46,7 +47,7 @@ body {
 }
 
 .markdown-section a {
-  color: $color-primary;
+  color: var(--theme-color, $color-primary);
   font-weight: 400;
 }
 
@@ -54,6 +55,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 +98,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;
@@ -114,7 +110,7 @@ body {
 
 .markdown-section blockquote {
   color: #858585;
-  border-left: 4px solid $color-primary;
+  border-left: 4px solid var(--theme-color, $color-primary);
   margin: 2em 0;
   padding-left: 20px;
 }
@@ -242,15 +238,3 @@ code .token {
   -webkit-font-smoothing: initial;
   -moz-osx-font-smoothing: initial;
 }
-
-.content span.light {
-  color: #7f8c8d;
-}
-
-.content span.info {
-  display: inline-block;
-  font-size: 0.85em;
-  margin-left: 20px;
-  vertical-align: middle;
-  width: 280px;
-}

src/themes/pure.css

@@ -1,3 +1,5 @@
 $color-primary: #000;
+$color-bg: #fff;
+$color-text: #000;
 $sidebar-width: 300px;
 @import "basic/layout";

src/themes/vue.css

@@ -1,18 +1,21 @@
 @import url('https://fonts.googleapis.com/css?family=Roboto+Mono|Source+Sans+Pro:300,400,600');
 
 $color-primary: #42b983;
+$color-bg: #fff;
+$color-text: #34495e;
 $sidebar-width: 300px;
 
 @import "basic/layout";
+@import "basic/coverpage";
 
 body {
-  background-color: #fff;
-  color: #34495e;
+  background-color: $color-bg;
 }
 
 /* sidebar */
 .sidebar {
   color: #364149;
+  background-color: $color-bg;
 
   li {
     margin: 6px 15px;
@@ -35,7 +38,7 @@ body {
   }
 
   ul li.active>a {
-    color: $color-primary;
+    color: var(--theme-color, $color-primary);
     font-weight: 600;
   }
 }
@@ -51,16 +54,10 @@ body {
 }
 
 .markdown-section a {
-  color: $color-primary;
+  color: var(--theme-color, $color-primary);
   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 +97,7 @@ body {
 .markdown-section ul,
 .markdown-section ol {
   line-height: 1.6em;
+  word-spacing: 0.05em;
 }
 
 .markdown-section ul,
@@ -109,7 +107,7 @@ body {
 
 .markdown-section blockquote {
   color: #858585;
-  border-left: 4px solid $color-primary;
+  border-left: 4px solid var(--theme-color, $color-primary);
   margin: 2em 0;
   padding-left: 20px;
 }
@@ -181,7 +179,7 @@ body {
 }
 
 .token.string {
-  color: $color-primary;
+  color: var(--theme-color, $color-primary);
 }
 
 .token.selector {
@@ -203,7 +201,7 @@ body {
 .token.control,
 .token.directive,
 .token.unit {
-  color: $color-primary;
+  color: var(--theme-color, $color-primary);
 }
 
 .token.keyword {
@@ -277,7 +275,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;
@@ -287,15 +285,3 @@ pre::after {
   text-align: right;
   top: 0;
 }
-
-.content span.light {
-  color: #7f8c8d;
-}
-
-.content span.info {
-  display: inline-block;
-  font-size: 0.85em;
-  margin-left: 20px;
-  vertical-align: middle;
-  width: 280px;
-}

src/tpl.js

@@ -1,4 +1,4 @@
-
+import { isMobile } from './util'
 /**
  * Render github corner
  * @param  {Object} data
@@ -21,22 +21,36 @@ export function corner (data) {
 
 /**
  * Render main content
- * @return {[type]}      [description]
  */
 export function main () {
-  return `<main>
-    <aside class="sidebar"></aside>
-    <section class="content">
+  const aside = `${toggle()}<aside class="sidebar"></aside>`
+
+  return (isMobile() ? `${aside}<main>` : `<main>${aside}`) +
+    `<section class="content">
       <article class="markdown-section"></article>
     </section>
-  </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>
+    <div class="mask"></div>
+  </section>`
+}
+
+export function toggle () {
   return `<button class="sidebar-toggle">
-    <span></span><span></span><span></span>
-  </button>`
+      <div class="sidebar-toggle-button">
+        <span></span><span></span><span></span>
+      </div>
+    </button>`
 }
 
 /**
@@ -58,3 +72,10 @@ export function tree (toc, tpl = '') {
   return tpl
 }
 
+export function helper (className, content) {
+  return `<p class="${className}">${content.slice(5).trim()}</p>`
+}
+
+export function theme (color) {
+  return `<style>:root{--theme-color: ${color};}</style>`
+}

src/util.js

@@ -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,64 @@ export function getRoute () {
 }
 
 export function isMobile () {
-  return /mobile/i.test(navigator.userAgent)
+  return document.body.clientWidth <= 600
+}
+
+export function slugify (string) {
+  const re = /[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,.\/:;<=>?@\[\]^`{|}~]/g
+  const maintainCase = false
+  const replacement = '-'
+
+  slugify.occurrences = slugify.occurrences || {}
+
+  if (typeof string !== 'string') return ''
+  if (!maintainCase) string = string.toLowerCase()
+
+  let slug = string.trim()
+    .replace(/<[^>\d]+>/g, '')
+    .replace(re, '')
+    .replace(/\s/g, replacement)
+    .replace(/-+/g, replacement)
+    .replace(/^(\d)/, '_$1')
+  let occurrences = slugify.occurrences[slug]
+
+  if (slugify.occurrences.hasOwnProperty(slug)) {
+    occurrences++
+  } else {
+    occurrences = 0
+  }
+
+  slugify.occurrences[slug] = occurrences
+
+  if (occurrences) {
+    slug = slug + '-' + occurrences
+  }
+
+  return slug
+}
+
+slugify.clear = function () {
+  slugify.occurrences = {}
+}
+
+const hasOwnProperty = Object.prototype.hasOwnProperty
+export const merge = Object.assign || function (to) {
+  for (let i = 1; i < arguments.length; i++) {
+    const from = Object(arguments[i])
+
+    for (const key in from) {
+      if (hasOwnProperty.call(from, key)) {
+        to[key] = from[key]
+      }
+    }
+  }
+
+  return to
+}
+
+export function emojify (text) {
+  return text
+    .replace(/:(\w*?):/ig, '<img class="emoji" src="https://assets-cdn.github.com/images/icons/emoji/$1.png" alt="$1" />')
+    .replace(/__colon__/g, ':')
 }