Frontmatter

The frontmatter allows to define metadata for the whole presentation. For every CLI option, there is a corresponding frontmatter option.

It must start the input file with a ---, and the frontmatter ends with the next ---. Inside, the metadata is given using a key-value syntax, with : used for the separation. Not quotes are needed, but no newline are accepted in the values. I’ll switch to yaml at some point…

---
dimension: 16:9
theme: vanier
---

# The rest of the presentation

Muspi merol

The current options for the frontmatter are:

  • attributes, for defining the attributes of the elements in the current file. Accepts a string with the syntax for attributes. Default value is an empty attribute.

  • toplevel-attributes, for defining the attributes of the whole presentation (useful in multi-file setting). Accepts a string with the syntax for attributes. Useful to control the first action executed. Default is slip enter="~duration:0".

  • theme, for selecting a theme. Accepts a string: either "default", "vanier" or a path to a file.

  • css for adding css files to the presentation. Accepts a space-separated list of paths. Spaces in path are not possible yet.

  • js for adding .js files to the presentation. Accepts a space-separated list of paths. Spaces in path are not possible yet.

  • dimension for defining the dimension of the presentation. Accepts a string, either "4:3" (1440x1080, the default), "16:9" (1920x1080), or "WIDTHxHEIGHT".

  • highlightjs-theme, for selecting a highlightjs theme. Accepts the name of a theme, corresponding to the name of a file in this list, stripped from its extension.

  • external-ids, for telling the slipshow compiler which ids will be present even if they do not seem to be present in the document. Accepts a list of space-separated ids. This is just in order to silence some warnings. This is useful when including svgs or math where some IDs are given.

Multifile presentations

When you split your presentation in multiple files, you can define a frontmatter in the included files. The fields present in multiple files will be combined when applicable. When not applicable, a warning will be raised.