status-im
/
codimd
mirror of https://github.com/status-im/codimd.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Sheogorath 2018-11-10 22:11:07 +01:00
parent 44ca7be294
commit 3020c11d11
No known key found for this signature in database
GPG Key ID: 1F05CC3635CDDFFD
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
public/docs/yaml-metadata.md
View File

@ -128,6 +128,17 @@ This option allow you to enable Disqus with your shortname.
disqus: codimd 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 slideOptions
--- ---
This option allow you provide custom options to slide mode. This option allow you provide custom options to slide mode.