-> v2.2.1

add a showcase

CHANGELOG.md

@@ -1,8 +1,25 @@
+## 2.2.1
+
+> 2017-02-11
+
+### Bug fixes
+- fix(search): crash when not content, fixed #68
+- fix(event): scroll active sidebar
+- fix(search): not work in mobile
+
+## 2.2.0
+
+### Features
+- Add `Google Analytics` plugin.
+```html
+<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+```
 ## 2.1.0
 ### Features
 - Add search plugin
 ```html
-<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+<script src="//unpkg.com/docsify"></script>
 <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
 ```
 

README.md

@@ -60,6 +60,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
 - [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.
+- [Mybatis-Plus](http://mp.baomidou.com/) - An enhanced toolkit of Mybatis to simplify development
 
 ## Similar projects
 - [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
@@ -76,13 +77,12 @@ These open-source projects are using docsify to generate their sites. Pull reque
 
 ## Development
 
-### prepare
 ```bash
 npm i && npm run dev
 open http://localhost:3000
 ```
 
-### More Language Highlight
+## More Language Highlight
 
 ```html
 <script src="//unpkg.com/docsify"></script>

build/build.js

@@ -47,3 +47,14 @@ isProd && build({
   moduleName: 'D.Search',
   plugins: [uglify()]
 })
+build({
+  entry: 'plugins/ga.js',
+  output: 'plugins/ga.js',
+  moduleName: 'D.GA'
+})
+isProd && build({
+  entry: 'plugins/ga.js',
+  output: 'plugins/ga.min.js',
+  moduleName: 'D.GA',
+  plugins: [uglify()]
+})

docs/README.md

@@ -468,7 +468,7 @@ If a document can have a search, can enhance some user experience. Installing th
 
 
 ```html
-<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+<script src="//unpkg.com/docsify"></script>
 <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
 ```
 
@@ -495,3 +495,20 @@ window.$docsify = {
   }
 }
 ```
+
+### Google Analytics
+
+Install the plugin and configure the track id.
+
+```html
+<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+```
+
+or
+
+```js
+window.$docsify = {
+  ga: 'UA-XXXXX-Y'
+}
+```

docs/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)
 
-# docsify <small>2.1.0</small>
+# docsify <small>2.2.1</small>
 
 > A magical documentation site generator.
 

docs/zh-cn.md

@@ -501,3 +501,20 @@ window.$docsify = {
   }
 }
 ```
+
+### Google Analytics
+
+安装插件并且配置 track id。
+
+```html
+<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+```
+
+或者
+
+```js
+window.$docsify = {
+  ga: 'UA-XXXXX-Y'
+}
+```

lib/docsify.js

@@ -199,6 +199,7 @@ function scrollActiveSidebar () {
   var hoveredOverSidebar = false;
   var anchors = document.querySelectorAll('.anchor');
   var sidebar = document.querySelector('.sidebar');
+  var sidebarContainer = sidebar.querySelector('.sidebar-nav');
   var sidebarHeight = sidebar.clientHeight;
 
   var nav = {};
@@ -246,12 +247,12 @@ function scrollActiveSidebar () {
       var currentPageOffset = 0;
       var currentActiveOffset = active.offsetTop + active.clientHeight + 40;
       var currentActiveIsInView = (
-        active.offsetTop >= sidebar.scrollTop &&
-        currentActiveOffset <= sidebar.scrollTop + sidebarHeight
+        active.offsetTop >= sidebarContainer.scrollTop &&
+        currentActiveOffset <= sidebarContainer.scrollTop + sidebarHeight
       );
       var linkNotFurtherThanSidebarHeight = currentActiveOffset - currentPageOffset < sidebarHeight;
       var newScrollTop = currentActiveIsInView
-        ? sidebar.scrollTop
+        ? sidebarContainer.scrollTop
         : linkNotFurtherThanSidebarHeight
           ? currentPageOffset
           : currentActiveOffset - sidebarHeight;
@@ -2799,7 +2800,8 @@ var OPTIONS = merge({
   auto2top: false,
   name: '',
   themeColor: '',
-  nameLink: window.location.pathname
+  nameLink: window.location.pathname,
+  ga: ''
 }, window.$docsify);
 var script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop();
 

lib/plugins/ga.js

@@ -0,0 +1,50 @@
+this.D = this.D || {};
+this.D.GA = (function () {
+'use strict';
+
+// From https://github.com/egoist/vue-ga/blob/master/src/index.js
+
+function appendScript () {
+  var script = document.createElement('script');
+  script.async = true;
+  script.src = 'https://www.google-analytics.com/analytics.js';
+  document.body.appendChild(script);
+}
+
+function init (id) {
+  if (!window.ga) {
+    appendScript();
+    window.ga = window.ga || function () {
+      (window.ga.q = window.ga.q || []).push(arguments);
+    };
+    window.ga.l = Number(new Date());
+    window.ga('create', id, 'auto');
+  }
+}
+
+function collect () {
+  init(window.$docsify.ga);
+  window.ga('set', 'page', location.href);
+  window.ga('send', 'pageview');
+}
+
+var install = function () {
+  if (!window.Docsify || !window.Docsify.installed) {
+    console.error('[Docsify] Please load docsify.js first.');
+    return
+  }
+
+  if (!window.$docsify.ga) {
+    console.error('[Docsify] ga is required.');
+    return
+  }
+
+  collect();
+  window.$docsify.plugins = [].concat(window.$docsify.plugins, collect);
+};
+
+var ga = install();
+
+return ga;
+
+}());

lib/plugins/ga.min.js

@@ -0,0 +1 @@
+this.D=this.D||{},this.D.GA=function(){"use strict";function o(){var o=document.createElement("script");o.async=!0,o.src="https://www.google-analytics.com/analytics.js",document.body.appendChild(o)}function i(i){window.ga||(o(),window.ga=window.ga||function(){(window.ga.q=window.ga.q||[]).push(arguments)},window.ga.l=Number(new Date),window.ga("create",i,"auto"))}function n(){i(window.$docsify.ga),window.ga("set","page",location.href),window.ga("send","pageview")}var w=function(){return window.Docsify&&window.Docsify.installed?window.$docsify.ga?(n(),void(window.$docsify.plugins=[].concat(window.$docsify.plugins,n))):void console.error("[Docsify] ga is required."):void console.error("[Docsify] Please load docsify.js first.")},s=w();return s}();

lib/plugins/search.js

@@ -80,6 +80,7 @@ var genIndex = function (path, content) {
         slug = ("#/" + path + "#" + id).replace(/\/+/, '/');
         INDEXS[slug] = { slug: slug, title: text, body: '' };
       } else {
+        if (!slug) { return }
         // other html tag
         if (!INDEXS[slug]) {
           INDEXS[slug] = {};
@@ -127,9 +128,11 @@ SearchComponent.prototype.render = function render (dom) {
 SearchComponent.prototype.bindEvent = function bindEvent () {
     var this$1 = this;
 
-  var input = document.querySelector('.search input');
-  var panel = document.querySelector('.results-panel');
+  var search = document.querySelector('.search');
+  var input = search.querySelector('.search input');
+  var panel = search.querySelector('.results-panel');
 
+  search.addEventListener('click', function (e) { return e.target.tagName !== 'A' && e.stopPropagation(); });
   input.addEventListener('input', function (e) {
     var target = e.target;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "A magical documentation generator.",
   "main": "lib/docsify.js",
   "files": [

src/event.js

@@ -10,6 +10,7 @@ export function scrollActiveSidebar () {
   let hoveredOverSidebar = false
   const anchors = document.querySelectorAll('.anchor')
   const sidebar = document.querySelector('.sidebar')
+  const sidebarContainer = sidebar.querySelector('.sidebar-nav')
   const sidebarHeight = sidebar.clientHeight
 
   const nav = {}
@@ -57,12 +58,12 @@ export function scrollActiveSidebar () {
       const currentPageOffset = 0
       const currentActiveOffset = active.offsetTop + active.clientHeight + 40
       const currentActiveIsInView = (
-        active.offsetTop >= sidebar.scrollTop &&
-        currentActiveOffset <= sidebar.scrollTop + sidebarHeight
+        active.offsetTop >= sidebarContainer.scrollTop &&
+        currentActiveOffset <= sidebarContainer.scrollTop + sidebarHeight
       )
       const linkNotFurtherThanSidebarHeight = currentActiveOffset - currentPageOffset < sidebarHeight
       const newScrollTop = currentActiveIsInView
-        ? sidebar.scrollTop
+        ? sidebarContainer.scrollTop
         : linkNotFurtherThanSidebarHeight
           ? currentPageOffset
           : currentActiveOffset - sidebarHeight

src/index.js

@@ -15,7 +15,8 @@ const OPTIONS = utils.merge({
   auto2top: false,
   name: '',
   themeColor: '',
-  nameLink: window.location.pathname
+  nameLink: window.location.pathname,
+  ga: ''
 }, window.$docsify)
 const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()
 

src/plugins/ga.js

@@ -0,0 +1,42 @@
+// From https://github.com/egoist/vue-ga/blob/master/src/index.js
+
+function appendScript () {
+  const script = document.createElement('script')
+  script.async = true
+  script.src = 'https://www.google-analytics.com/analytics.js'
+  document.body.appendChild(script)
+}
+
+function init (id) {
+  if (!window.ga) {
+    appendScript()
+    window.ga = window.ga || function () {
+      (window.ga.q = window.ga.q || []).push(arguments)
+    }
+    window.ga.l = Number(new Date())
+    window.ga('create', id, 'auto')
+  }
+}
+
+function collect () {
+  init(window.$docsify.ga)
+  window.ga('set', 'page', location.href)
+  window.ga('send', 'pageview')
+}
+
+const install = function () {
+  if (!window.Docsify || !window.Docsify.installed) {
+    console.error('[Docsify] Please load docsify.js first.')
+    return
+  }
+
+  if (!window.$docsify.ga) {
+    console.error('[Docsify] ga is required.')
+    return
+  }
+
+  collect()
+  window.$docsify.plugins = [].concat(window.$docsify.plugins, collect)
+}
+
+export default install()

src/plugins/search.js

@@ -76,6 +76,7 @@ const genIndex = function (path, content = '') {
         slug = `#/${path}#${id}`.replace(/\/+/, '/')
         INDEXS[slug] = { slug, title: text, body: '' }
       } else {
+        if (!slug) return
         // other html tag
         if (!INDEXS[slug]) {
           INDEXS[slug] = {}
@@ -180,9 +181,11 @@ class SearchComponent {
   }
 
   bindEvent () {
-    const input = document.querySelector('.search input')
-    const panel = document.querySelector('.results-panel')
+    const search = document.querySelector('.search')
+    const input = search.querySelector('.search input')
+    const panel = search.querySelector('.results-panel')
 
+    search.addEventListener('click', e => e.target.tagName !== 'A' && e.stopPropagation())
     input.addEventListener('input', e => {
       const target = e.target