Update Configuration Options (YAML Meta Data) authored by Armin Bernstetter's avatar Armin Bernstetter
...@@ -102,7 +102,8 @@ autoSlideStoppable: "true" | "false" ...@@ -102,7 +102,8 @@ autoSlideStoppable: "true" | "false"
### backgroundTransition ### backgroundTransition
<details> <details>
- Transition style for full page slide backgrounds (defaults no `none`) - Transition style for full page slide backgrounds (defaults no `none`).
See also [Configuration-Options-(YAML-Meta-Data)#transition](Configuration-Options-(YAML-Meta-Data)#transition)
``` ```
backgroundTransition: none/fade/slide/convex/concave/zoom backgroundTransition: none/fade/slide/convex/concave/zoom
...@@ -762,14 +763,14 @@ For example, to set the background color of a all H2 header elements ...@@ -762,14 +763,14 @@ For example, to set the background color of a all H2 header elements
### template ### template
- base-css - base-css: The first CSS file that is loaded by the template (defaults to `''`).
- css - css: A list of additional CSS files. `base-css` does not need to be defined to use `css`
- favicon TODO: Need working example - favicon
- include-js - include-js: a list of Javascript files that are included in the slide deck before Reveal.js is initialized (defaults to `[]`)
- title-page - title-page
- teaser-img - teaser-img: an image that is placed below the title line on the title slide (defaults to `''`)
- banner - banner: a header image on the title slide (defaults to `''`)
- affiliation-logo - affiliation-logo: An image that is placed above the affiliation information on the title slide (defaults to `''`)
<details> <details>
Template subsumes several different options that live under its namespace. All of them can be defined under one `template` definition. Template subsumes several different options that live under its namespace. All of them can be defined under one `template` definition.
...@@ -779,24 +780,17 @@ Example: (more detailed examples under each specific option) ...@@ -779,24 +780,17 @@ Example: (more detailed examples under each specific option)
``` ```
template: template:
favicon: favicon:
# the first CSS file that is loaded by the template (defaults to `''`)
base-css: basefile.css base-css: basefile.css
#
css: css:
- file1.css - file1.css
- file2.css - file2.css
# a list of Javascript files that are included in the slide deck before Reveal.js is initialized (defaults to `[]`)
include-js: include-js:
- file1.js - file1.js
- file2.js - file2.js
title-page: title-page:
# an image that is placed below the title line on the title slide (defaults to `''`)
teaser-img: include/teaser.png teaser-img: include/teaser.png
# a header image on the title slide (defaults to `''`)
banner: include/banner.png banner: include/banner.png
# an image that is placed above the affiliation information on the title slide (defaults to `''`)
affiliation-logo: include/affiliation.png affiliation-logo: include/affiliation.png
``` ```
</details> </details>
... ...
......