From 1b58871c06dddf9a340e647d4b0cb6dbe07b4a92 Mon Sep 17 00:00:00 2001 From: Pol Dellaiera Date: Thu, 1 Sep 2022 11:14:26 +0200 Subject: [PATCH] Update `yaml-metadata.md`. Update `slideOptions` documentation and links. Signed-off-by: Pol Dellaiera --- public/docs/yaml-metadata.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index d7907005c..092913713 100644 --- a/public/docs/yaml-metadata.md +++ b/public/docs/yaml-metadata.md @@ -142,8 +142,12 @@ type: slide ## slideOptions This option allows you to provide custom options to slide mode. -Please below document for more details: - + +Slide mode is achieved using [Reveal](https://revealjs.com/), an HTML presentation framework. +In HedgeDoc 1, Reveal version 3 is in use. + +See the below document for more details on the available slide options: + You could also set slide theme which named in below css files: @@ -161,12 +165,12 @@ slideOptions: ## opengraph -This option allows you to override the default generated opengraph metadata. +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) +> default: not set (uses auto-generated metadata) **Example** ```yml