Nimbledeck documentation¶
Nimbledeck writes slides that run things: plain Markdown for the story, plus live animation, 3D, Python, video and websites, presented from one browser tab.
The home page is a Nimbledeck deck, written in one Markdown file. Watch it first, or start writing your own.
Find your way¶
Get started¶
Install, make a deck, run it. Get started.
Write a deck¶
The syntax, the layouts and the rules nimbledeck check enforces. Writing a deck, Layouts.
Look and feel¶
Live components and brand themes. Components, Themes.
See it run¶
The example decks and what needs Python. Live demos, Run it locally.
Why Nimbledeck¶
Nimbledeck is a thin layer on top of Slidev for decks that need to run things. The content stays Markdown, so a person or an AI agent can write a deck from a document in one pass, and it diffs well in git.
Markdown first¶
One message per slide, a layout name, and nothing else. No <div>, no per-slide CSS.
Live components¶
Orbit, Scene3D, PyStream, LiveCode, Quiz, Chart, Clip and more, ready to drop in. See the gallery.
Real Python¶
Heavy work runs in a local process and the slide only displays it. Edit Python on the slide and the plot updates.
Safe on stage¶
A failing demo shows an offline panel and reconnects on its own. It cannot stop the talk.
Checked for you¶
nimbledeck check lints the Markdown. nimbledeck verify opens the deck in Chrome and reports clipped or blurry content.
Themeable¶
Twenty built-in looks, from editorial and swiss to neon, terminal, blueprint and an ink-friendly print, chosen with one line of the header. Brand themes restyle every live component through --nd-* tokens. Looks and themes.
Five minutes to a deck¶
Full walkthrough in Get started.
How it fits together¶
deck.md (Markdown + layout names + <Component /> tags)
|
| nimbledeck check known layouts, short titles, no inline HTML or CSS, assets exist
v
Slidev (browser) <---- HTTP / WebSocket ----> local Python processes (demos, streams, live code)
started and stopped by `nimbledeck run`
More in Architecture.
Status
Early. Everything was run in Chrome on macOS. Windows, Firefox and Safari are not tested yet.