summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Michelson2019-10-04 19:58:02 +0200
committerErik Michelson2019-10-04 19:58:02 +0200
commit8f61d840de0ff1a40fbb61ce9e688d9372f9117e (patch)
tree82b4ca1cad4e7aae49b91c9ded851a3d54b7e823
parent2881f8211aaaa2def3f3cedabf635f03733ac82e (diff)
Added documentation for opengraph metadata
Signed-off-by: Erik Michelson <erik@liltv.de>
-rw-r--r--public/docs/yaml-metadata.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md
index 8e59c8f2..f09591bc 100644
--- a/public/docs/yaml-metadata.md
+++ b/public/docs/yaml-metadata.md
@@ -159,3 +159,20 @@ slideOptions:
transition: fade
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
+```