Skip to content

Commit 196af7a

Browse files
committed
docs: Update homepage
1 parent 079c807 commit 196af7a

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

docs/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,15 +264,32 @@ More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
264264
265265
### 7. Advanced configuration
266266
267-
_This advanced section is optional, so you may skip to [Github Pages](#setup-github-pages-site) section._
267+
The configuration steps above already get you a prettier and more usable site in my opinion than the barebones one which the _Docsify_ `init` command or their _Quickstart_ guide gives you. This section covers advanced steps - you may skip these and jump straight to the [Github Pages](#setup-github-pages-site) section.
268268
269-
The configuration steps above already get you a prettier and more usable site in my opinion than the barebones one which the _Docsify_ `init` command or their _Quickstart_ guide gives you.
269+
#### App configuration
270270
271-
For further configuration, look at the _Docsify_ [Configuration](https://docsify.js.org/#/configuration) page.
271+
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.
272272
273-
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.
273+
For available parameters, these are documented on the _Docsify_ [Configuration](https://docsify.js.org/#/configuration) page.
274274
275-
If you want know a summary view of what the defaults are for the app on _index.html_, see the _Docsify_ [config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
275+
For defaults - see _Docsify_ [config.js](https://github.com/docsifyjs/docsify/blob/develop/src/core/config.js) script.
276+
277+
For some values to look at (provided here with defaults):
278+
279+
```js
280+
window.$docsify = {
281+
// ...
282+
283+
// Maximum Table of content level.
284+
maxLevel: 6,
285+
// Add table of contents (TOC) in custom sidebar. Try value of 2.
286+
subMaxLevel: 0,
287+
}
288+
```
289+
290+
See also the [Google Analytics tracking](https://docsify.js.org/#/plugins?id=google-analytics) section which needs a plugin script to be loaded.
291+
292+
#### Favicon
276293
277294
You can customize _index.html_ with a custom favicon if one exists.
278295

0 commit comments

Comments
 (0)