mkdeck 0.1.1

mkdeck turns Markdown or Python into HTML slide decks. Each deck uses reveal.js, draws math with KaTeX, and plays Brax robot runs offline.

Install

Try mkdeck once, with nothing installed:

uvx mkdeck new talk
uvx mkdeck serve talk

Install the command to use it every day. mkdeck needs Python 3.11 or newer:

uv tool install mkdeck    # or: pip install mkdeck

Quickstart

mkdeck new talk                                   # create talk/deck.md, talk/deck.yml, talk/assets/
mkdeck serve talk --open                          # preview the deck, and reload when you save
mkdeck build talk --out site                      # write a folder that you can publish
mkdeck build talk --single-file --out talk.html   # write one HTML file
mkdeck export talk --out talk.pdf                 # print a PDF (needs the check extra)

Example

A slide is a block of Markdown, and a --- line starts the next slide. This deck has two slides:

---
title: Vault runs
---

Five of five seeds cross the wall at 22 N m.

![Run 3](assets/run3.html)

---

The torque cap decides the outcome.

| Cap | Crossings |
| --- | --- |
| 18 N m | 2 |
| 22 N m | 5 |

mkdeck adds a title slide, frames the HTML page as a figure, and marks each number in a darker ink.

What you can do

• Write slides in Markdown with layouts, bullets, tables, and speaker notes.
• Show live figures, such as a Plotly chart or any HTML page.
• Convert Brax pages into rollouts that play offline.
• Draw math with KaTeX and diagrams with Mermaid. Diagrams load Mermaid from a CDN.
• Build a folder or one file, then check every slide and export a PDF. Both commands need the check extra.
• Generate a deck from Python when your slides report computed numbers.
• Restyle a deck with CSS variables, and add your own components.

Read the full documentation, or look up a command in the CLI reference.

Contribute and license

Bug reports and pull requests are welcome, so read CONTRIBUTING.md first.

mkdeck is MIT licensed. The package also carries reveal.js, KaTeX, three.js, and the KaTeX and Roboto fonts under their own licenses. See THIRD_PARTY_NOTICES.md.