Reveal.js format

Section slides, ordinal dates, and the options for laying a deck out.

Worked examples of the mcanouil-revealjs option and of the Reveal.js document options, including the two that help while a deck is being built.

mcanouil-revealjs produces slides. One option belongs to the format, and the rest are document options under extensions: mcanouil:.

The Reference covers the format. The Reference lists the document options, with the default of each.

A presentation

---
title: "My Presentation"
format:
  mcanouil-revealjs:
    brand-mode: dark
---

brand-mode defaults to dark for a deck, where a Typst document defaults to light. Typst format covers the mismatch.

Section outlines

section-outline puts a list of the subsections on each section slide, so the audience sees what the section holds. It is marked as a navigation landmark, so a screen reader announces it as one.

extensions:
  mcanouil:
    section-outline: false
Warning

This option does more than its name says. The same pass that builds the outline also marks the slide as a section slide and wraps its heading in the banner, so switching it off removes the whole section-slide treatment, not only the list.

A deck whose sections hold one slide each still gets the banner, so leave the option on unless the section styling is unwanted as well.

Ordinal dates

date-superscript writes an ordinal date with a raised suffix, so 1st and 2nd are set the way they are printed.

extensions:
  mcanouil:
    date-superscript: false

Turn it off for a deck in a language whose ordinals do not work that way.

The title slide

hide-title-slide-chrome clears the title slide of the menu, the logo, the footer, and the slide number. The rest of the deck keeps them.

favicon-from-logo builds the browser tab icon from the slide logo, so a deck served from a URL carries its own mark.

extensions:
  mcanouil:
    hide-title-slide-chrome: false
    favicon-from-logo: false

Code annotations as fragments

code-annotation-fragments steps through the annotations on a code block one at a time, as fragments, rather than showing them all at once.

extensions:
  mcanouil:
    code-annotation-fragments: false

Keep it on for a teaching deck, where each line of a block is explained in turn.

Two options for laying a deck out

debug-borders outlines the slide area and every slide, with a colour for each kind of slide and a separate colour for a nested slide. It shows where one slide ends and the next begins, which is what a layout problem usually needs.

extensions:
  mcanouil:
    debug-borders: true

grid-background draws a faint grid behind the slides, which helps when elements have to line up. It is one option for both outputs, and HTML format covers it.

Turn both off before presenting. debug-borders is off unless a deck asks for it, so a deck that never sets it is safe.

Back to top