summaryrefslogtreecommitdiff
path: root/public/docs
diff options
context:
space:
mode:
authorWu Cheng-Han2016-08-01 00:08:44 +0800
committerWu Cheng-Han2016-08-01 00:08:44 +0800
commit46ccf2d0a3dc8f651ad5b49703e70d9dc983ab7b (patch)
treee7439c92b696ce9dfa905f0c29f3c72ff56f5690 /public/docs
parentb367e110b639ab707e848d1d6de70bb094cd0edd (diff)
Update docs for customize slides and new YAML metadata
Diffstat (limited to 'public/docs')
-rw-r--r--public/docs/slide-example.md2
-rw-r--r--public/docs/yaml-metadata.md27
2 files changed, 29 insertions, 0 deletions
diff --git a/public/docs/slide-example.md b/public/docs/slide-example.md
index af579ceb..8daf1d2e 100644
--- a/public/docs/slide-example.md
+++ b/public/docs/slide-example.md
@@ -5,6 +5,8 @@ This feature still in beta, may have some issues.
For details please visit:
https://github.com/hakimel/reveal.js/
+You can use `URL query` or `slideOptions` of the YAML metadata to customize your slides.
+
---
## First slide
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md
index 4a235686..d22fccda 100644
--- a/public/docs/yaml-metadata.md
+++ b/public/docs/yaml-metadata.md
@@ -105,3 +105,30 @@ You can only use whether `true` or `false`.
```xml
breaks: false
```
+
+GA
+---
+This option allow you to enable Google Analytics with your ID.
+
+> default: not set (which won't enable)
+
+**Example**
+```xml
+GA: UA-12345667-8
+```
+
+slideOptions
+---
+This option allow you provide custom options to slide mode.
+Please below document for more details:
+https://github.com/hakimel/reveal.js/#configuration
+
+**Notice: always use two spaces as indention in YAML metadata!**
+
+> default: not set (which use default slide options)
+
+**Example**
+```xml
+slideOptions:
+ transition: fade
+``` \ No newline at end of file