Quickstart | Docs

Install

In a Node.js 22+ project:

Bash
pnpm add -D @recit/cli

Not on npm yet

The packages arrive with the public alpha (P5). Until then, run Récit from the repository: git clone https://github.com/vguerand/recit.git && pnpm install && pnpm build, then pnpm --filter recit-example-deck-starter dev.

Create a deck

Bash
npx recit init slides.md --config

This creates slides.md, a cover.svg image and (with --config) a recit.config.ts. It refuses to overwrite an existing file unless you pass --force.

Run the development server

Bash
npx recit dev slides.md --open

Edit slides.md and save: the slide updates without reloading the page, and you stay on the current slide. Errors and warnings (overloaded slides, images without alternative text…) are printed in the terminal with their line number.

The result

This is the starter deck, live. Click it, then use the arrow keys:

Click the deck, then use ← → · 3 slides · 00:16Open fullscreen →

Keyboard shortcuts

Key	Action
→ ↓ Space PageDown	Next slide or step
← ↑ PageUp	Previous slide or step
Home / End	First / last slide
T	Light / dark theme
S	Presenter console (new window)
F	Fullscreen
H	Density HUD (dev mode)
L	Laser pointer · Shift+D: pen · C: clear
B / W	Black / white screen

The URL follows your position: ?slide=3&step=1. Share it to open the deck at the right place.

Next: follow the tutorial.