Skip to content

Commit

Permalink
Add ogImage to site-config docs (#487)
Browse files Browse the repository at this point in the history
Fixes #451
  • Loading branch information
miralemd authored and JoelMarcey committed Mar 7, 2018
1 parent 48ee457 commit a8d7299
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-site-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a8d7299

Please sign in to comment.