Skip to content

Commit 7ac1a23

Browse files
docs: Update advanced section
1 parent 5474baa commit 7ac1a23

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

docs/README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -306,19 +306,35 @@ For available parameters, these are documented on the _Docsify_ [Configuration](
306306
307307
For defaults - see _Docsify_ [config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
308308
309-
For some values to look at (provided here with defaults):
309+
See some values below which are worth considering for the siderbar.
310310
311311
```js
312312
window.$docsify = {
313-
// ...
314-
315-
// Maximum Table of content level.
313+
// Maximum Table of Contents (TOC) level. Default value shown here.
316314
maxLevel: 6,
317-
// Add table of contents (TOC) in custom sidebar. Try value of 2.
315+
316+
// Add table of contents (TOC) in custom sidebar. Default value shown here. Try a value of 2.
318317
subMaxLevel: 0,
318+
319+
logo: '/_media/icon.svg',
320+
321+
name: 'docsify'
319322
}
320323
```
321324
325+
Change the homepage. These recommendations come from the docs.
326+
327+
```js
328+
window.$docsify = {
329+
// Change to /home.md
330+
homepage: 'home.md',
331+
332+
// Or use the readme in your repo
333+
homepage: 'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
334+
};
335+
```
336+
337+
322338
See also the [Google Analytics tracking](https://docsify.js.org/#/plugins?id=google-analytics) section which needs a plugin script to be loaded.
323339
324340
#### Favicon

0 commit comments

Comments
 (0)