diff options
| author | Sheogorath | 2018-11-10 22:11:07 +0100 |
|---|---|---|
| committer | Sheogorath | 2018-11-14 01:06:20 +0100 |
| commit | 3020c11d113a138257bbfd0a3e891385bd17a203 (patch) | |
| tree | 04c53e5630aee76d828065c0edeef4e6c34a1693 /public/docs | |
| parent | 44ca7be29475e6c14f872aeee0f956e478ae4218 (diff) | |
Add documentation for type field
The yaml-metadata documentation should mention the type field. This is
also open for future extension.
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
Diffstat (limited to 'public/docs')
| -rw-r--r-- | public/docs/yaml-metadata.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index 888345f7..e3012b3a 100644 --- a/public/docs/yaml-metadata.md +++ b/public/docs/yaml-metadata.md @@ -128,6 +128,17 @@ This option allow you to enable Disqus with your shortname. disqus: codimd ``` +type +--- +This option allows you to switch the document view to the slide preview, to simplify live editing of presentations. + +> default: not set + +**Example:** +```xml +type: slide +``` + slideOptions --- This option allow you provide custom options to slide mode. |