From 44ca7be29475e6c14f872aeee0f956e478ae4218 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Sat, 10 Nov 2018 21:54:59 +0100 Subject: [PATCH 1/4] Activate slide editing mode for example We have this awesome editing mode for slide shows. We just don't enable it or tell anyone that it exists. Maybe we should do this. This patch sets the type for the slide example. Signed-off-by: Sheogorath --- public/docs/slide-example.md | 1 + 1 file changed, 1 insertion(+) diff --git a/public/docs/slide-example.md b/public/docs/slide-example.md index 5503cbd..4950366 100644 --- a/public/docs/slide-example.md +++ b/public/docs/slide-example.md @@ -1,4 +1,5 @@ --- +type: slide slideOptions: transition: slide --- From 3020c11d113a138257bbfd0a3e891385bd17a203 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Sat, 10 Nov 2018 22:11:07 +0100 Subject: [PATCH 2/4] 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 --- public/docs/yaml-metadata.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index 888345f..e3012b3 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. From 43021283e42ab58e02350ab3796c79404fcf18c4 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Sat, 10 Nov 2018 22:12:36 +0100 Subject: [PATCH 3/4] Some minor improvements to the yaml-metadata docs Switching form XAML to YAML syntax highlighting and fixing some grammar. Signed-off-by: Sheogorath --- public/docs/yaml-metadata.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index e3012b3..839616a 100644 --- a/public/docs/yaml-metadata.md +++ b/public/docs/yaml-metadata.md @@ -25,7 +25,7 @@ This option will set the note title which prior than content title. > default: not set **Example** -```xml +```yml title: meta title ``` @@ -36,7 +36,7 @@ This option will set the note description. > default: not set **Example** -```xml +```yml description: meta description ``` @@ -47,7 +47,7 @@ This option will set the tags which prior than content tags. > default: not set **Example** -```xml +```yml tags: features, cool, updated ``` @@ -62,7 +62,7 @@ So you can prevent any search engine index your note by set `noindex, nofollow`. > default: not set **Example** -```xml +```yml robots: noindex, nofollow ``` @@ -75,13 +75,13 @@ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes > default: not set (which will be en) **Example** -```xml +```yml langs: ja-jp ``` dir --- -This option provide to describe the direction of the text in this note. +This option specifies the direction of the text in this note. You can only use whether `rtl` or `ltr`. Look more at here: http://www.w3.org/International/questions/qa-html-dir @@ -89,7 +89,7 @@ http://www.w3.org/International/questions/qa-html-dir > default: not set (which will be ltr) **Example** -```xml +```yml dir: rtl ``` @@ -102,29 +102,29 @@ You can only use whether `true` or `false`. > default: not set (which will be true) **Example** -```xml +```yml breaks: false ``` GA --- -This option allow you to enable Google Analytics with your ID. +This option allows you to enable Google Analytics with your ID. > default: not set (which won't enable) **Example** -```xml +```yml GA: UA-12345667-8 ``` disqus --- -This option allow you to enable Disqus with your shortname. +This option allows you to enable Disqus with your shortname. > default: not set (which won't enable) **Example** -```xml +```yml disqus: codimd ``` @@ -135,13 +135,13 @@ This option allows you to switch the document view to the slide preview, to simp > default: not set **Example:** -```xml +```yml type: slide ``` slideOptions --- -This option allow you provide custom options to slide mode. +This option allows you to provide custom options to slide mode. Please below document for more details: https://github.com/hakimel/reveal.js/#configuration @@ -153,7 +153,7 @@ https://github.com/hakimel/reveal.js/tree/master/css/theme > default: not set (which use default slide options) **Example** -```xml +```yml slideOptions: transition: fade theme: white From d94271c81a90c6dec08b65dc84ccd21668de7c51 Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Sat, 10 Nov 2018 22:16:46 +0100 Subject: [PATCH 4/4] Add documentation for slide view mode to features page Since it's a very useful feature, we should mention it in multiple locations. So we mention it in the slide mode section of the features page. Signed-off-by: Sheogorath --- public/docs/features.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/public/docs/features.md b/public/docs/features.md index 31c08d2..a4ffb63 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -72,9 +72,11 @@ Notes can be embedded as follows: ## [Slide Mode](./slide-example): You can use a special syntax to organize your note into slides. -After that, you can use the **Slide Mode** to make a presentation. +After that, you can use the **[Slide Mode](./slide-example)** to make a presentation. Visit the above link for details. +To switch the editor into slide mode, set the [document type](./yaml-metadata#type) to `slide`. + View === ## Table of Contents: