Copy page

Formats

Formats

A format decides how a story is told. The source stays the same: front matter, scenes separated by --- and ::: directives. Only the renderer changes, chosen with the format: key of the front matter (deck by default).

Markdown
---
title: Lorem ipsum
format: deck # deck | motion | report | toon | book | roadmap | calendar | stories
---

--- layout=cover

# Lorem ipsum

Status

Formats are released one by one. Each one gets its packages, its examples, its section in this documentation and its own site.

Available formats

Deck

Slide decks written in Markdown or MDX: layouts, highlighted code, math, diagrams, progressive steps, speaker notes, presenter console, smartphone remote, static site, single HTML file and PDF. See Deck, and the gallery on presentation.recit.dev.

Docs

Every story can be published inside a Récit site: one prerendered route per story, <StoryEmbed /> and <StoryGallery /> in MDX pages, and a Pagefind search that returns the slide. This site uses it. See Stories in a site.

Motion

The same story becomes a video. Scenes become shots made of animated blocks (title, chapter, statement, stat, list, compare bars, UI mock), in 16:9, 1:1 or 9:16. The same block engine plays in the browser (embeds, pages) and renders an MP4. recit render story.md produces the video, and <StoryEmbed slug="…" format="motion" /> plays it in a page. Video is an output of motion, not a separate format. Its Markdown syntax is specified in Motion, and motion.recit.dev shows the gallery.

Planned formats

Report

Quarterly reports, studies and frozen dashboards. Numbers always come from the data, never from the text: :value{data=sales field=revenue agg=sum}, ::chart and ::table read CSV, JSON or YAML sources and are computed at build time (charts rendered as SVG). Output: a continuous HTML page with a table of contents, and a paged PDF with numbered contents, running headers and page numbers.

Toon

Webtoon episodes: panel images, with the text of the bubbles kept apart so lettering is generated and translatable. :::bubble, :::caption and :::sfx are positioned on each panel. Output: a vertical scroll reader, image slices sized for publishing platforms, and a vertical video through motion.

Book

Books, manuals and theses written across several Markdown files. Chapters, footnotes, cross-references and an index. Output: a print-ready PDF (odd and even pages, running titles, roman then arabic numbering), a valid EPUB 3, and a web edition where each chapter becomes a documentation page.

Roadmap

Product, open-source or team roadmaps: lanes, items with status, dates, owners and tags, milestones and dependencies. Three views (now-next-later, timeline, kanban) with filters in the URL. Exports: ICS for milestones, RSS for shipped items, PDF for the timeline. The roadmap of Récit itself will be the first one published.

Calendar

Meetups, courses, releases and editorial calendars, in Markdown or JSON. Recurrences, time zones, localized dates. Month, week, agenda and year views, one page per event, and a subscribable ICS feed. A past event can link to its deck or its video.

Stories

Full-screen vertical cards, played with a tap, a swipe or the keyboard, with progress bars and autoplay. Embeddable in a page or a landing, exportable as one image per card (1080×1920) or as a vertical video through motion.

Bridges between formats

A story can change format by changing format: or with recit convert. Only bridges with a closed mapping are promised; anything else produces an explicit error.