From 3020c11d113a138257bbfd0a3e891385bd17a203 Mon Sep 17 00:00:00 2001
From: Sheogorath
Date: Sat, 10 Nov 2018 22:11:07 +0100
Subject: 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>
---
 public/docs/yaml-metadata.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'public')

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.
-- 
cgit v1.2.3