Settings & directives¶
Every > key: value parameter, by scope. Presentation settings go in the
settings block, before the first slide; per-slide directives go right
after a slide marker. Contextual directives (size, align,
paragraph-spacing) are in their own generated page; the
options that belong to a block construct (> gap: in a grid, > margin: /
> border: in a table, …) are in Constructs.
Presentation settings¶
Title slide and identity¶
Setting |
Description |
|---|---|
|
Browser-tab title of the generated HTML. Default: |
|
Author name on the title slide. Repeatable. May contain inline HTML. Add an indented |
|
Affiliation line on the title slide (rendered between authors and event). Repeatable. |
|
Author photo, nested with an author line (either order). |
|
Round author photos on the title slide. Default: |
|
Event — typically the location and date. |
|
Institutional logo on the first slide / header strip. Repeatable. |
Look¶
Setting |
Description |
|---|---|
|
Theme. |
|
Code highlighting theme (highlight.js demo). Default: |
|
Header / footer band heights, as a fraction of the slide height. |
|
Presentation-wide text defaults — see Contextual directives. |
Behaviour and reveal.js passthrough¶
Setting |
Description |
|---|---|
|
Slide numbers. Disabled by default. Any reveal.js value (e.g. |
|
Navigation controls. Defaults to the reveal.js built-in value. |
|
Progress bar. Alias |
|
Background transition. |
|
Canvas size and fit margin (reveal.js options), e.g. |
|
Disable inline markdown (bold/italic/spans) for the whole deck. |
any other |
Passed straight to |
Math¶
Setting |
Description |
|---|---|
|
KaTeX macros from a file of |
|
Inline KaTeX macro. Repeatable. |
|
Extra KaTeX options, merged with the bundled-KaTeX config and the macros (never replacing them). |
Build pipeline and export¶
Setting |
Description |
|---|---|
|
Build hook: a shell command run from the deck folder before every compile (and on every save under |
|
BibTeX file for citations and the bibliography. See Bibliography. |
|
References per bibliography slide. Default: 5. |
|
Speaker-notes font size. Default: |
|
Default SVG animation step duration. Default: |
|
PDF export granularity: |
Per-slide directives¶
Written right after a slide marker (===, ---, %%%, >>> first:,
>>> biblio):
Directive |
Description |
|---|---|
|
Hide the slide. |
|
Dark style for the current slide. |
|
Per-slide theme switch (restored on navigation). |
|
Subtitle (first slide only). |
|
Title of the bibliography slides (after |
|
Drop the text stroke on a |
|
Remove the fixed header. |
|
Background image or colour. |
|
Video background (looped, muted). |
|
Background opacity for a background video. |
|
Text colour for the current slide. |
|
Raw attributes appended to the |
|
Speaker notes — the rest of the slide source is notes; the optional value sets their font size. |
|
Cite a BibTeX entry. Repeatable; markers with |
|
Inline SVG embedded in the slide DOM. |
|
Hide SVG elements (by id) in the inlined SVG — reveal them later with |
|
SVG animation step. Repeatable. See SVG animation. |
|
Slide layout geometry — see Layout parameters. |
Anywhere in the content¶
Directive |
Description |
|---|---|
|
Replaced by the file’s contents at build time (recursive, deck-local paths). See Authoring › Including other files. |
|
|
|
Closes the named environment. |