Scenes
A story is a list of scenes. The same file is read as slides by the deck format and as shots by the motion format: what follows is true of both. What only a deck does lives under Formats › Deck.
Split the story
A --- line separates two scenes. It can carry the scene's attributes, as key=value pairs or
JSON:
Markdown
id names a scene, whatever the format. layout, cols and transition above are read by the
deck: see Slide options. A film reads type, dur and hold
instead — see Motion.
Story front matter
The first YAML block holds the story's metadata, and takes precedence over recit.config.ts:
YAML
A format's own settings can sit flat, as above, or under its section — deck: for the slides,
motion: for the film — so one source can carry both without a name clash. Every key is listed in
recit.config.
Small inline elements
These directives are the same in every format:
| Syntax | Result |
|---|---|
:badge[New]{type=success} | badge (default, primary, success, warning, danger) |
:kbd[Ctrl] | keyboard key |
:::callout{type=tip title="Tip"} | callout (info, tip, warning, danger, note) |
Every directive and component is shown with its props on components.recit.dev.