Docs for secondary navigation

This commit is contained in:
Joel Marcey 2018-03-12 17:16:06 -07:00 committed by GitHub
parent 1a245a81b2
commit 7c0651649c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -170,3 +170,13 @@ The links in the top navigation bar get `siteNavItemActive` and `siteNavGroupAct
* The blog link when a blog post, or the blog listing page is being displayed * The blog link when a blog post, or the blog listing page is being displayed
These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same css rule. These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same css rule.
## Secondary On-Page Navigation
We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`.
```
onPageNav: 'separate',
```
Currently, `separate` is the only option available for this field. This provides a separate navigation on the right side of the page.