github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-29 06:34:26 -05:00
Code Issues Projects Releases Packages Wiki Activity

Added documentation for opengraph metadata

Browse source 
Signed-off-by: Erik Michelson <erik@liltv.de>
This commit is contained in:
Erik Michelson 2019-10-04 19:58:02 +02:00
parent 2881f8211a
commit 8f61d840de
No known key found for this signature in database
GPG key ID: 6C1E7B9159DABCBA
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
public/docs/yaml-metadata.md
View file

@ -159,3 +159,20 @@ slideOptions:
transition: fade transition: fade
theme: white theme: white
``` ```
opengraph
---
This option allows you to override the default generated opengraph metadata.
See the [OpenGraph protocol documentation](https://ogp.me) for more information.
**Notice: always use two spaces as indention in YAML metadata!**
> default: not set (uses auto-generated metadata)
**Example**
```yml
opengraph:
title: Special title for OpenGraph protocol
image: https://dummyimage.com/600x600/000/fff
image:type: image/png
```