Skip to content

Commit 3020c11

Browse files
committed
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 <[email protected]>
1 parent 44ca7be commit 3020c11

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

public/docs/yaml-metadata.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,17 @@ This option allow you to enable Disqus with your shortname.
128128
disqus: codimd
129129
```
130130

131+
type
132+
---
133+
This option allows you to switch the document view to the slide preview, to simplify live editing of presentations.
134+
135+
> default: not set
136+
137+
**Example:**
138+
```xml
139+
type: slide
140+
```
141+
131142
slideOptions
132143
---
133144
This option allow you provide custom options to slide mode.

0 commit comments

Comments
 (0)