mirror of https://github.com/status-im/codimd.git
Update docs for customize slides and new YAML metadata
This commit is contained in:
parent
b367e110b6
commit
46ccf2d0a3
|
@ -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
|
||||
|
|
|
@ -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
|
||||
```
|
Loading…
Reference in New Issue