From 8f61d840de0ff1a40fbb61ce9e688d9372f9117e Mon Sep 17 00:00:00 2001
From: Erik Michelson
Date: Fri, 4 Oct 2019 19:58:02 +0200
Subject: Added documentation for opengraph metadata

Signed-off-by: Erik Michelson <erik@liltv.de>
---
 public/docs/yaml-metadata.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'public/docs')

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
+```
-- 
cgit v1.2.3