chore: add changelog 4.8.5

CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="4.8.5"></a>
+## [4.8.5](https://github.com/docsifyjs/docsify/compare/v4.8.4...v4.8.5) (2018-11-02)
+
+
+### Bug Fixes
+
+* expose version info for Docsify, fixed [#641](https://github.com/docsifyjs/docsify/issues/641) ([aa719e3](https://github.com/docsifyjs/docsify/commit/aa719e3))
+
+
+
 <a name="4.8.4"></a>
 ## [4.8.4](https://github.com/docsifyjs/docsify/compare/v4.8.3...v4.8.4) (2018-11-01)
 

docs/_coverpage.md

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

docs/helpers.md

@@ -88,6 +88,7 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 ![logo](https://docsify.js.org/_media/icon.svg ':size=100')
 
 <!-- Support percentage -->
+
 ![logo](https://docsify.js.org/_media/icon.svg ':size=10%')
 ```
 
@@ -99,4 +100,46 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
 
 ```md
 ### 你好，世界！ :id=hello-world
-```
+```
+
+## Markdown in html tag
+
+You need to insert a space between the html and markdown content.
+This is useful for rendering markdown content in the details element.
+
+```markdown
+<details>
+<summary>Self-assessment (Click to expand)</summary>
+
+- Abc
+- Abc
+
+</details>
+```
+
+<details>
+<summary>Self-assessment (Click to expand)</summary>
+
+- Abc
+- Abc
+
+</details>
+
+Or markdown content can be wrapped in html tag.
+
+```markdown
+<div style='color: red'>
+
+- listitem
+- listitem
+- listitem
+
+</div>
+```
+
+<div style='color: red'>
+
+- Abc
+- Abc
+
+</div>

docs/write-a-plugin.md

@@ -6,41 +6,41 @@ A plugin is simply a function that takes `hook` as an argument. The hook support
 
 ```js
 window.$docsify = {
- plugins: [
-  function (hook, vm) {
-    hook.init(function() {
-      // Called when the script starts running, only trigger once, no arguments,
-    })
+  plugins: [
+    function(hook, vm) {
+      hook.init(function() {
+        // Called when the script starts running, only trigger once, no arguments,
+      });
 
-    hook.beforeEach(function(content) {
-      // Invoked each time before parsing the Markdown file.
-      // ...
-      return content
-    })
+      hook.beforeEach(function(content) {
+        // Invoked each time before parsing the Markdown file.
+        // ...
+        return content;
+      });
 
-    hook.afterEach(function(html, next) {
-      // Invoked each time after the Markdown file is parsed.
-      // beforeEach and afterEach support asynchronous。
-      // ...
-      // call `next(html)` when task is done.
-      next(html)
-    })
+      hook.afterEach(function(html, next) {
+        // Invoked each time after the Markdown file is parsed.
+        // beforeEach and afterEach support asynchronous。
+        // ...
+        // call `next(html)` when task is done.
+        next(html);
+      });
 
-    hook.doneEach(function() {
-      // Invoked each time after the data is fully loaded, no arguments,
-      // ...
-    })
+      hook.doneEach(function() {
+        // Invoked each time after the data is fully loaded, no arguments,
+        // ...
+      });
 
-    hook.mounted(function() {
-      // Called after initial completion. Only trigger once, no arguments.
-    })
+      hook.mounted(function() {
+        // Called after initial completion. Only trigger once, no arguments.
+      });
 
-    hook.ready(function() {
-      // Called after initial completion, no arguments.
-    })
-  }
- ]
-}
+      hook.ready(function() {
+        // Called after initial completion, no arguments.
+      });
+    }
+  ]
+};
 ```
 
 !> You can get internal methods through `window.Docsify`. Get the current instance through the second argument.
@@ -54,21 +54,21 @@ Add footer component in each pages.
 ```js
 window.$docsify = {
   plugins: [
-    function (hook) {
+    function(hook) {
       var footer = [
         '<hr/>',
         '<footer>',
         '<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
         '<span>Proudly published with <a href="https://github.com/docsifyjs/docsify" target="_blank">docsify</a>.</span>',
         '</footer>'
-      ].join('')
+      ].join('');
 
-      hook.afterEach(function (html) {
-        return html + footer
-      })
+      hook.afterEach(function(html) {
+        return html + footer;
+      });
     }
   ]
-}
+};
 ```
 
 ### Edit Button
@@ -77,17 +77,35 @@ window.$docsify = {
 window.$docsify = {
   plugins: [
     function(hook, vm) {
-      hook.beforeEach(function (html) {
-        var url = 'https://github.com/docsifyjs/docsify/blob/master/docs' + vm.route.file
-        var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n'
+      hook.beforeEach(function(html) {
+        var url =
+          'https://github.com/docsifyjs/docsify/blob/master/docs' +
+          vm.route.file;
+        var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n';
 
-        return editHtml
-          + html
-          + '\n----\n'
-          + 'Last modified {docsify-updated} '
-          + editHtml
-      })
+        return (
+          editHtml +
+          html +
+          '\n----\n' +
+          'Last modified {docsify-updated} ' +
+          editHtml
+        );
+      });
     }
   ]
-}
+};
 ```
+
+## Tips
+
+### Get docsify version
+
+```
+console.log(window.Docsify.version)
+```
+
+Current version: <span id='tip-version'>loading</span>
+
+<script>
+document.getElementById('tip-version').innerText = Docsify.version
+</script>

lib/docsify.js

@@ -5008,7 +5008,13 @@ var util = Object.freeze({
 });
 
 function initGlobalAPI () {
-  window.Docsify = {util: util, dom: dom, get: get, slugify: slugify};
+  window.Docsify = {
+    util: util,
+    dom: dom,
+    get: get,
+    slugify: slugify,
+    version: '4.8.5'
+  };
   window.DocsifyCompiler = Compiler;
   window.marked = marked;
   window.Prism = prism;
@@ -5044,11 +5050,6 @@ eventMixin(proto);
  */
 initGlobalAPI();
 
-/**
- * Version
- */
-Docsify.version = '4.8.4';
-
 /**
  * Run Docsify
  */

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.8.4",
+  "version": "4.8.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify",
-  "version": "4.8.4",
+  "version": "4.8.5",
   "description": "A magical documentation generator.",
   "author": {
     "name": "qingwei-li",

packages/docsify-server-renderer/package-lock.json

@@ -37,5 +37,5 @@
       "integrity": "sha1-6DWIAbhrg7F1YNTjw4LXrvIQCUQ="
     }
   },
-  "version": "4.8.4"
+  "version": "4.8.5"
 }

packages/docsify-server-renderer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsify-server-renderer",
-  "version": "4.8.4",
+  "version": "4.8.5",
   "description": "docsify server renderer",
   "author": {
     "name": "qingwei-li",

src/core/global-api.js

@@ -7,7 +7,13 @@ import marked from 'marked'
 import prism from 'prismjs'
 
 export default function () {
-  window.Docsify = {util, dom, get, slugify}
+  window.Docsify = {
+    util,
+    dom,
+    get,
+    slugify,
+    version: '__VERSION__'
+  }
   window.DocsifyCompiler = Compiler
   window.marked = marked
   window.Prism = prism

src/core/index.js

@@ -35,11 +35,6 @@ eventMixin(proto)
  */
 initGlobalAPI()
 
-/**
- * Version
- */
-Docsify.version = '__VERSION__'
-
 /**
  * Run Docsify
  */