Récit documentation

Récit turns one Markdown (or MDX) source into many outputs. You write scenes separated by --- lines, Récit compiles them into a story, and a format renders that story: a slide deck today, and later a video, a data report, a webtoon, a book, a roadmap, a calendar or web stories.

The first format, deck, is ready: grids, images, highlighted code, math, diagrams, progressive steps, a presenter console, a smartphone remote, PDF export and single-file HTML export. Every deck can also be embedded in a Récit site, as the pages of this one do.

Quickstart

TerminalBash
pnpm add -D @recit/cli
npx recit init slides.md
npx recit dev slides.md
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.

Markdownslides.md
---
title: Lorem ipsum
---

--- layout=cover

# Hello 👋

--- layout=grid cols=2

# Two ideas

:::card
### Simple
Plain Markdown, nothing else.
:::

:::card
### Complete
Themes, exports, presenter console.
:::

The quickstart explains each command, and the tutorial takes you from this file to a themed deck published in a documentation site.

Where to start?

📘

Documentation

Quickstart, tutorial, writing scenes, configuration, presenting and exporting.

Learn more→
🧭

Formats

One source, many outputs: what is available today and what is coming next.

Learn more→
🎨

Theme

Colors, typography, radius, footer, dark mode, aspect ratio and custom CSS.

Learn more→
⌨️

CLI

recit init, dev, build and export, with every option.

Learn more→
🧩

Components

Grid, Card, Callout, Step, Mermaid and the other components, in every format.

Learn more→
🖼️

Demos

The gallery of decks, with their source and a fullscreen preview.

Learn more→