Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e538978

Browse files
Update README.md
1 parent f30da8e commit e538978

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

docs/README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -376,36 +376,51 @@ The configuration steps above already get you a prettier and more usable site in
376376

377377
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.
378378

379-
For available parameters, these are documented on the _Docsify_ [Configuration](https://docsify.js.org/#/configuration) page.
379+
**Links**
380380

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
382395

383-
- **Sidebar** - config options relating to the sidebar. Default values are shown here.
384-
```js
385-
window.$docsify = {
386396
// Maximum Table of Contents (TOC) level.
387397
maxLevel: 6,
388398

389399
// 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.
390401
subMaxLevel: 0,
391402

392403
// Add your logo to the top of our sidebar menu.
393404
logo: '/_media/icon.svg',
394405

395406
// Name which appears at the top of the sidebar.
396407
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 = {
402417
// Change to /home.md rather than /README.md file.
403418
homepage: 'home.md',
404419

405420
// Specify the README.md at the root of your repo, rather than in the docs directory.
406421
homepage: 'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
407-
};
408-
```
422+
};
423+
```
409424

410425
#### Set favicon
411426

0 commit comments

Comments
 (0)