3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 16:29:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add secondary, page-specific navigation documentation (#498)

Browse source 
And enable for docusaurus.io
This commit is contained in:
Joel Marcey 2018-03-12 16:27:37 -07:00 • committed by GitHub
parent cbdab2ba11
commit f1893d5fea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api-site-config.md
View file

@ -126,6 +126,10 @@ h1 {
`ogImage` - url for an Open Graph image. This image will show up when your site is shared on Facebook, Twitter and any other websites/apps where the Open Graph protocol is supported.
`onPageNav` - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:
- `separate` - The secondary navigation is a separate pane defaulting on the right side of a document. See http://docusaurus.io/docs/en/translation.html for an example.
`organizationName` - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.
`scripts` - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.