feat: new option hideSidebar

docs/configuration.md

@@ -22,7 +22,7 @@ The DOM element to be mounted on initialization. It can be a CSS selector string
 ```js
 window.$docsify = {
   el: '#app'
-};
+}
 ```
 
 ## repo
@@ -37,7 +37,7 @@ window.$docsify = {
   repo: 'docsifyjs/docsify',
   // or
   repo: 'https://github.com/docsifyjs/docsify/'
-};
+}
 ```
 
 ## maxLevel
@@ -50,7 +50,7 @@ Maximum Table of content level.
 ```js
 window.$docsify = {
   maxLevel: 4
-};
+}
 ```
 
 ## loadNavbar
@@ -67,7 +67,7 @@ window.$docsify = {
 
   // load from nav.md
   loadNavbar: 'nav.md'
-};
+}
 ```
 
 ## loadSidebar
@@ -84,9 +84,24 @@ window.$docsify = {
 
   // load from summary.md
   loadSidebar: 'summary.md'
-};
+}
 ```
 
+## hideSidebar
+
+- Type : `Boolean`
+- Default: `true`
+
+This option will completely hide your sidebar and wont render any content of the side even .
+
+````js
+window.$docsify = {
+
+  hideSidebar: true,
+
+};
+
+
 ## subMaxLevel
 
 - Type: `Number`
@@ -98,7 +113,7 @@ Add table of contents (TOC) in custom sidebar.
 window.$docsify = {
   subMaxLevel: 2
 };
-```
+````
 
 ## auto2top
 
@@ -110,7 +125,7 @@ Scrolls to the top of the screen when the route is changed.
 ```js
 window.$docsify = {
   auto2top: true
-};
+}
 ```
 
 ## homepage
@@ -128,7 +143,7 @@ window.$docsify = {
   // Or use the readme in your repo
   homepage:
     'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
-};
+}
 ```
 
 ## basePath
@@ -147,7 +162,7 @@ window.$docsify = {
   // Even can load files from other repo
   basePath:
     'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
-};
+}
 ```
 
 ## relativePath
@@ -187,7 +202,7 @@ window.$docsify = {
 
   // Relative path disabled (default value)
   relativePath: false
-};
+}
 ```
 
 ## coverpage
@@ -212,7 +227,7 @@ window.$docsify = {
     '/': 'cover.md',
     '/zh-cn/': 'cover.md'
   }
-};
+}
 ```
 
 ## logo
@@ -224,7 +239,7 @@ Website logo as it appears in the sidebar, you can resize by CSS.
 ```js
 window.$docsify = {
   logo: '/_media/icon.svg'
-};
+}
 ```
 
 ## name
@@ -236,15 +251,15 @@ Website name as it appears in the sidebar.
 ```js
 window.$docsify = {
   name: 'docsify'
-};
+}
 ```
 
 The name field can also contain custom HTML for easier customization:
 
 ```js
 window.$docsify = {
   name: '<span>docsify</span>'
-};
+}
 ```
 
 ## nameLink
@@ -263,7 +278,7 @@ window.$docsify = {
     '/zh-cn/': '/zh-cn/',
     '/': '/'
   }
-};
+}
 ```
 
 ## markdown
@@ -287,9 +302,9 @@ window.$docsify = {
   // function
   markdown: function(marked, renderer) {
     // ...
-    return marked;
+    return marked
   }
-};
+}
 ```
 
 ## themeColor
@@ -301,7 +316,7 @@ Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en
 ```js
 window.$docsify = {
   themeColor: '#3F51B5'
-};
+}
 ```
 
 ## alias
@@ -319,7 +334,7 @@ window.$docsify = {
       'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
     '/.*/_sidebar.md': '/_sidebar.md' // See #301
   }
-};
+}
 ```
 
 ## autoHeader
@@ -332,7 +347,7 @@ If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.m
 window.$docsify = {
   loadSidebar: true,
   autoHeader: true
-};
+}
 ```
 
 ## executeScript
@@ -344,7 +359,7 @@ Execute the script on the page. Only parse the first script tag([demo](themes)).
 ```js
 window.$docsify = {
   executeScript: true
-};
+}
 ```
 
 ```markdown
@@ -366,7 +381,7 @@ Disabled emoji parse.
 ```js
 window.$docsify = {
   noEmoji: true
-};
+}
 ```
 
 ## mergeNavbar
@@ -378,7 +393,7 @@ Navbar will be merged with the sidebar on smaller screens.
 ```js
 window.$docsify = {
   mergeNavbar: true
-};
+}
 ```
 
 ## formatUpdated
@@ -395,9 +410,9 @@ window.$docsify = {
   formatUpdated: function(time) {
     // ...
 
-    return time;
+    return time
   }
-};
+}
 ```
 
 ## externalLinkTarget
@@ -410,7 +425,7 @@ Target to open external links inside the markdown. Default `'_blank'` (new windo
 ```js
 window.$docsify = {
   externalLinkTarget: '_self' // default: '_blank'
-};
+}
 ```
 
 ## cornerExternalLinkTarget
@@ -423,7 +438,7 @@ Target to open external link at the top right corner. Default `'_blank'` (new wi
 ```js
 window.$docsify = {
   cornerExternalLinkTarget: '_self' // default: '_blank'
-};
+}
 ```
 
 ## externalLinkRel
@@ -436,7 +451,7 @@ Default `'noopener'` (no opener) prevents the newly opened external page (when [
 ```js
 window.$docsify = {
   externalLinkTarget: '' // default: 'noopener'
-};
+}
 ```
 
 ## routerMode
@@ -447,7 +462,7 @@ window.$docsify = {
 ```js
 window.$docsify = {
   routerMode: 'history' // default: 'hash'
-};
+}
 ```
 
 ## noCompileLinks
@@ -459,7 +474,7 @@ Sometimes we do not want docsify to handle our links. See [#203](https://github.
 ```js
 window.$docsify = {
   noCompileLinks: ['/foo', '/bar/.*']
-};
+}
 ```
 
 ## onlyCover
@@ -471,7 +486,7 @@ Only coverpage is loaded when visiting the home page.
 ```js
 window.$docsify = {
   onlyCover: false
-};
+}
 ```
 
 ## requestHeaders
@@ -485,7 +500,7 @@ window.$docsify = {
   requestHeaders: {
     'x-token': 'xxx'
   }
-};
+}
 ```
 
 Such as setting the cache
@@ -495,11 +510,9 @@ window.$docsify = {
   requestHeaders: {
     'cache-control': 'max-age=600'
   }
-};
+}
 ```
 
-
-
 ## ext
 
 - type: `String`
@@ -509,7 +522,7 @@ Request file extension.
 ```js
 window.$docsify = {
   ext: '.md'
-};
+}
 ```
 
 ## fallbackLanguages
@@ -527,7 +540,7 @@ Example:
 ```js
 window.$docsify = {
   fallbackLanguages: ['fr', 'de']
-};
+}
 ```
 
 ## notFoundPage
@@ -539,15 +552,15 @@ Load the `_404.md` file:
 ```js
 window.$docsify = {
   notFoundPage: true
-};
+}
 ```
 
 Load the customised path of the 404 page:
 
 ```js
 window.$docsify = {
   notFoundPage: 'my404.md'
-};
+}
 ```
 
 Load the right 404 page according to the localisation:
@@ -558,7 +571,7 @@ window.$docsify = {
     '/': '_404.md',
     '/de': 'de/_404.md'
   }
-};
+}
 ```
 
 > Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.