Templates

Every example of the repository is a ready-to-use template. Copy its folder with degit, then run recit dev on its deck file. Each template page shows the source and an interactive preview.

Starter

The minimum: plain Markdown, no configuration.

Bash
npx degit vguerand/recit/examples/deck-starter my-deck
cd my-deck
npx recit dev slides.md

Tech talk

A conference talk with cards, a quote, a Mermaid diagram and speaker notes.

Bash
npx degit vguerand/recit/examples/deck-tech-talk my-talk
cd my-talk
npx recit dev slides.md

Showcase

Every layout and directive, a full recit.config.ts, custom CSS and the Metric component.

Bash
npx degit vguerand/recit/examples/deck-showcase my-deck
cd my-deck
npx recit dev slides.md

Pitch

A 4:3 product pitch with a light theme and brand colors.

Bash
npx degit vguerand/recit/examples/deck-pitch my-pitch
cd my-pitch
npx recit dev slides.md

Course

A course handout with math, a table, tabbed code, a diagram and a progressive quiz.

Bash
npx degit vguerand/recit/examples/deck-course my-course
cd my-course
npx recit dev slides.md

MDX

An .mdx deck with built-in components, stateful React components and expressions.

Bash
npx degit vguerand/recit/examples/deck-mdx my-mdx-deck
cd my-mdx-deck
npx recit dev slides.mdx

Site

Stories published inside a Récit site, one prerendered page per story.

Bash
npx degit vguerand/recit/examples/site-embed my-docs
cd my-docs
npm install
npx recit-site dev

Without a template

recit init writes a starter deck in the current folder:

Bash
npx recit init slides.md --config
npx recit dev slides.md

When the deck is ready, npx recit export slides.md writes a PDF and npx recit export slides.md --html a single self-contained HTML file.