From 46ccf2d0a3dc8f651ad5b49703e70d9dc983ab7b Mon Sep 17 00:00:00 2001 From: Wu Cheng-Han Date: Mon, 1 Aug 2016 00:08:44 +0800 Subject: Update docs for customize slides and new YAML metadata --- public/docs/slide-example.md | 2 ++ public/docs/yaml-metadata.md | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) (limited to 'public/docs') 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 -- cgit v1.2.3