mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-11 08:07:26 +02:00
Add secondary, page-specific navigation documentation (#498)
And enable for docusaurus.io
This commit is contained in:
parent
cbdab2ba11
commit
f1893d5fea
3 changed files with 7 additions and 0 deletions
|
@ -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.
|
`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.
|
`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.
|
`scripts` - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.
|
||||||
|
|
|
@ -62,6 +62,8 @@ const siteConfig = {
|
||||||
scripts: ['https://buttons.github.io/buttons.js'],
|
scripts: ['https://buttons.github.io/buttons.js'],
|
||||||
// You may provide arbitrary config keys to be used as needed by your template.
|
// You may provide arbitrary config keys to be used as needed by your template.
|
||||||
repoUrl: 'https://github.com/facebook/test-site',
|
repoUrl: 'https://github.com/facebook/test-site',
|
||||||
|
/* On page navigation for the current documentation page */
|
||||||
|
// onPageNav: 'separate',
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = siteConfig;
|
module.exports = siteConfig;
|
||||||
|
|
|
@ -163,6 +163,7 @@ const siteConfig = {
|
||||||
facebookAppId: '1615782811974223',
|
facebookAppId: '1615782811974223',
|
||||||
twitter: 'true',
|
twitter: 'true',
|
||||||
ogImage: 'img/docusaurus.png',
|
ogImage: 'img/docusaurus.png',
|
||||||
|
onPageNav: 'separate',
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = siteConfig;
|
module.exports = siteConfig;
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue