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

Add ogImage to site-config docs (#487)

Browse source 
Fixes #451
This commit is contained in:
Miralem Drek 2018-03-07 22:10:32 +01:00 • committed by Joel Marcey
parent 48ee457ec9
commit a8d7299ef2
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -124,6 +124,8 @@ h1 {
`markdownPlugins` - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.
`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.
`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.