The slide model¶

Learn the four classes that describe a deck, so that you can build any slide in Python.

Markdown and Python meet in these classes: the Markdown loader produces them, and the renderer reads them. Because there is one code path, the two ways to write a deck cannot drift apart.

The API reference lists every field and signature.

Build a slide with a table¶

This slide holds a sentence, a table, and speaker notes:

from mkdeck import Slide, Table

Slide(
    id="torque-cap",
    sentence="The higher cap raises the crossing rate.",
    table=Table(
        columns=["Cap", "Crossings"], rows=[["18 N m", "2"], ["22 N m", "5"]]
    ),
    notes="The 18 N m runs stall against the wall.",
)

Slide has the same fields as the slide options, plus embeds, table, and html.

Set the deck settings¶

Deck carries every setting of deck.yml and the frontmatter as a field. The fields are title, date, theme, units, extra_css, extra_js, reveal, and title_slide. See Deck settings.

units replaces DEFAULT_UNITS. To add a unit, extend the default list:

from mkdeck import DEFAULT_UNITS, Deck

deck = Deck(title="Vault runs", units=[*DEFAULT_UNITS, "GPa"])

Format text¶

Text in a slide takes inline Markdown and passes raw HTML through unchanged. So when the text comes from data that you do not control, such as a run name or a log line, escape it first:

from html import escape

from mkdeck import Slide

Slide(sentence=escape(log_line))

Limits¶

Next: Load a deck.