Skip to content

Commit 46ccf2d

Browse files
committed
Update docs for customize slides and new YAML metadata
1 parent b367e11 commit 46ccf2d

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

public/docs/slide-example.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ This feature still in beta, may have some issues.
55
For details please visit:
66
https://github.com/hakimel/reveal.js/
77

8+
You can use `URL query` or `slideOptions` of the YAML metadata to customize your slides.
9+
810
---
911

1012
## First slide

public/docs/yaml-metadata.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,30 @@ You can only use whether `true` or `false`.
105105
```xml
106106
breaks: false
107107
```
108+
109+
GA
110+
---
111+
This option allow you to enable Google Analytics with your ID.
112+
113+
> default: not set (which won't enable)
114+
115+
**Example**
116+
```xml
117+
GA: UA-12345667-8
118+
```
119+
120+
slideOptions
121+
---
122+
This option allow you provide custom options to slide mode.
123+
Please below document for more details:
124+
https://github.com/hakimel/reveal.js/#configuration
125+
126+
**Notice: always use two spaces as indention in YAML metadata!**
127+
128+
> default: not set (which use default slide options)
129+
130+
**Example**
131+
```xml
132+
slideOptions:
133+
transition: fade
134+
```

0 commit comments

Comments
 (0)