github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-02-16 14:24:40 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update yaml-metadata.md.

Browse source 
Update `slideOptions` documentation and links.

Signed-off-by: Pol Dellaiera <pol.dellaiera@protonmail.com>
This commit is contained in:
Pol Dellaiera 2022-09-01 11:14:26 +02:00 committed by David Mehren
parent 2644640017
commit 1b58871c06
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -142,8 +142,12 @@ type: slide
## slideOptions
This option allows you to provide custom options to slide mode.
Please below document for more details:
<https://github.com/hakimel/reveal.js/#configuration>
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:
<https://github.com/hakimel/reveal.js/blob/3.9.2/README.md#configuration>
You could also set slide theme which named in below css files:
<https://github.com/hakimel/reveal.js/tree/master/css/theme>
@ -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