3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-03 09:57:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add a scroll to top button siteConfig option (#723)

Browse source
This commit is contained in:
Lespagnol Rémy 2018-06-06 21:34:32 +02:00 • committed by Joel Marcey
parent a43cc597f8
commit aee255219b
4 changed files with 40 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -153,6 +153,10 @@ h1 {
`separateCss` - Folders inside which any `css` files will not be processed and concatenated to Docusaurus' styles. This is to support static `html` pages that may be separate from Docusaurus with completely separate styles.
`scrollToTop` - Set this to `true` if you want to enable the scroll to top button at the bottom of your site.
`scrollToTopOptions` - Optional options configuration for the scroll to top button. You do not need to use this, even if you set `scrollToTop` to `true`; it just provides you more configuration control of the button. You can find more options [here](https://github.com/vfeskov/vanilla-back-to-top/blob/v7.1.14/OPTIONS.md). By default, we set the zIndex option to 100.
`stylesheets` - Array of CSS sources to load. The link tag will be inserted in the HTML head.
`translationRecruitingLink` - URL for the `Help Translate` tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.
@ -246,6 +250,10 @@ const siteConfig = {
twitterUsername: 'docusaurus',
twitterImage: 'img/docusaurus.png',
ogImage: 'img/docusaurus.png',
scrollToTop: true,
scrollToTopOptions: {
zIndex: 100
}
};
module.exports = siteConfig;