You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+27-12Lines changed: 27 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -376,36 +376,51 @@ The configuration steps above already get you a prettier and more usable site in
376
376
377
377
You can update the config parameters passed in on the _index.html_ page. There are some useful things there in like adjusting the sidebar levels, putting a logo in the sidebar or setting your root _README.md_ as your homepage. There is even a search bar you can add.
378
378
379
-
For available parameters, these are documented on the _Docsify_[Configuration](https://docsify.js.org/#/configuration) page.
379
+
**Links**
380
380
381
-
For defaults - see _Docsify_[config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
381
+
- For available parameters, these are documented on the _Docsify_[Configuration](https://docsify.js.org/#/configuration) page.
382
+
- For defaults - see _Docsify_[config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
383
+
- To see an app config in use, see [index.html](https://gi?id=twitter-policiesthub.com/MichaelCurrin/docsify-js-template/blob/master/docs/index.html) of DocsifyJS Template project.
384
+
385
+
386
+
**Sidebar**
387
+
388
+
Config options relating to the sidebar. Default values are shown here.
389
+
390
+
```js
391
+
window.$docsify= {
392
+
// Recommended to set this to true - when transitioning between pages,
393
+
// it can look weird if you don't get to the top of the page.
394
+
auto2top:false
382
395
383
-
-**Sidebar** - config options relating to the sidebar. Default values are shown here.
384
-
```js
385
-
window.$docsify= {
386
396
// Maximum Table of Contents (TOC) level.
387
397
maxLevel:6,
388
398
389
399
// Add table of contents (TOC) in custom sidebar. Try a value of 2.
400
+
// This might only apply when using auto sidebar and not custom one.
390
401
subMaxLevel:0,
391
402
392
403
// Add your logo to the top of our sidebar menu.
393
404
logo:'/_media/icon.svg',
394
405
395
406
// Name which appears at the top of the sidebar.
396
407
name:'docsify'
397
-
}
398
-
```
399
-
-**Homepage**- You might not need this, but in case you want to use a different homepage target. These recommendations come from the docs.
400
-
```js
401
-
window.$docsify = {
408
+
}
409
+
```
410
+
411
+
**Homepage**
412
+
413
+
Configure the homepage settings. You might not need this, but in case you want to use a different homepage target. These recommendations come from the docs.
414
+
415
+
```js
416
+
window.$docsify= {
402
417
// Change to /home.md rather than /README.md file.
403
418
homepage:'home.md',
404
419
405
420
// Specify the README.md at the root of your repo, rather than in the docs directory.
0 commit comments