Update home authored by Henrik Tramberend's avatar Henrik Tramberend
......@@ -21,30 +21,39 @@ Inherited from [reveal.js](https://github.com/hakimel/reveal.js/wiki/Keyboard-Sh
## YAML-Header
Parameter | Options | Effect
---|---|---
`author` | String | Displayed on first slide
`date` | String | Displayed on first slide
`title` | String | Displayed on first slide
`subtitle` | String | Displayed on first slide
`controls` | `0` or `1` | Turn arrow controls on/off
`progress` | `0` or `1` | Turn progress bar on/off
`slideNumber` | `true` or `false` | Turn slide numbers on/off
[...?]
| Parameter | Options | Effect |
|---------------|----------------------------------|--------------------------------|
| `author` | String | Displayed on first slide |
| `date` | String | Displayed on first slide |
| `title` | String | Displayed on first slide |
| `subtitle` | String | Displayed on first slide |
| `controls` | `0` or `1` | Turn arrow controls on/off |
| `progress` | `0` or `1` | Turn progress bar on/off |
| `slideNumber` | `true` or `false` | Turn slide numbers on/off |
| `lang` | Any ISO Language Code (eg. `de`) | HTML content language |
| `dir` | `RTL` or `LTR` | Text content direction |
| `author-meta` | | HTML document header meta data |
| `date-meta` | | HTML document header meta data |
| `keywords` | | HTML document header meta data |
| `theme` | | |
| `css` | | Additional CSS resources |
| `history` | `true` or `false` | Show slides in browser history |
A complete list of all meta data options can be found in the Pandoc HTML template(`resource/template/deck.html`).
## Columns
A column slide can be defined by `{layout="columns"}` in the slide header and by defining the orientation and scope each column in subheaders with `{.left}`, `{.center}` (optional), or `{.right}` tags.
Tag | Target | Effect | Example
---|---|---|---
`{layout="columns"}` | Slide headers (`#`) | Use columns of this slide | `# Slide header {layout="columns"}`
`{.left}` | Secondary headers (`##`) | Define start of left column | `## {.left}` or `## Text {.left}`
`{.center}` | Secondary headers (`##`) | Define start of central column (optional) |
`{.right}` | Secondary headers (`##`) | Define start of right column |
`{.mid}` | Slide headers (`#`) or secondary headers (`##`) | Vertically centers columns. Can be assigned to the slider header for all columns or to individual columns. | `# Text {layout="columns" .mid}` or `## {.right .mid}`
| Tag | Target | Effect | Example |
|----------------------|-------------------------------------------------|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| `{layout="columns"}` | Slide headers (`#`) | Use columns of this slide | `# Slide header {layout="columns"}` |
| `{.left}` | Secondary headers (`##`) | Define start of left column | `## {.left}` or `## Text {.left}` |
| `{.center}` | Secondary headers (`##`) | Define start of central column (optional) | |
| `{.right}` | Secondary headers (`##`) | Define start of right column | |
| `{.top}` | Secondary headers (`##`) | Define start of top row | |
| `{.bottom}` | Secondary headers (`##`) | Define start of bottom row | |
| `{.mid}` | Slide headers (`#`) or secondary headers (`##`) | Vertically centers columns. Can be assigned to the slider header for all columns or to individual columns. | `# Text {layout="columns" .mid}` or `## {.right .mid}` |
### Example:
......@@ -68,11 +77,11 @@ Tag | Target | Effect | Example
Slides can be vertically compressed to decrease the height of the content by assigning `{.dense}`, `{.x-dense}`, or `{.xx-dense}` to slide headers.
Tag | Target | Effect | Example
---|---|---|---
`{.dense}` | Slide headers (`#`) | Decrease height of content | `# Header {.dense}`
`{.x-dense}` | Slide headers (`#`) | Additionally, decrease font size | `# Header {.x-dense}`
`{.xx-dense}` | Slide headers (`#`) | Further decrease font size | `# Header {.xx-dense}`
| Tag | Target | Effect | Example |
|---------------|---------------------|----------------------------------|------------------------|
| `{.dense}` | Slide headers (`#`) | Decrease height of content | `# Header {.dense}` |
| `{.x-dense}` | Slide headers (`#`) | Additionally, decrease font size | `# Header {.x-dense}` |
| `{.xx-dense}` | Slide headers (`#`) | Further decrease font size | `# Header {.xx-dense}` |