# Decks

> Animated slide decks, built with agents.

## Getting started

- [Quickstart](https://decks.steamfield.io/docs/getting-started/quickstart.md): Install slidev-addon-decks with Slidev and its base theme, run decks init for shared agent guidance, scaffold a story deck and start the dev server.
- [Your first story deck](https://decks.steamfield.io/docs/getting-started/your-first-story-deck.md): What decks new --story writes, how a story slide is put together, and where to look in the example decks.
- [Add Decks to an existing Slidev deck](https://decks.steamfield.io/docs/getting-started/add-decks-to-an-existing-deck.md): Install the addon next to an existing Slidev deck, enable it in the headmatter and register the deck with decks.json.

## Concepts

- [Beats and the story timeline](https://decks.steamfield.io/docs/concepts/beats-and-the-story-timeline.md): How a story stage turns Slidev's click count into beats, why stepping back replays in reverse, and what useStage returns.
- [Ink marks](https://decks.steamfield.io/docs/concepts/ink-marks.md): The Vue components that draw onto a story stage, from InkLine and InkBars to chips, rules and numbers.
- [Story vs conventional decks](https://decks.steamfield.io/docs/concepts/story-vs-conventional-decks.md): When to use a story deck, with one pinned visualization per slide, and when a conventional deck of bullets, tables and charts is the better fit.

## Guides

- [Theming with theme.json](https://decks.steamfield.io/docs/guides/theming-with-theme-json.md): Restyle a deck with a theme.json next to its slides.md that overrides only the keys you name in packages/decks/theme/default.json.
- [Writing decks with an agent](https://decks.steamfield.io/docs/guides/writing-decks-with-an-agent.md): Shared deck-writing guidance for seven agent platforms, thin entry points, Claude Code hooks, and safe init updates.
- [Checking a deck](https://decks.steamfield.io/docs/guides/checking-a-deck.md): The manifest check, the prose lint and its hook, the fact extractor, and the shot and snap screenshot commands.
- [Exporting to PDF](https://decks.steamfield.io/docs/guides/exporting-to-pdf.md): Export a registered deck to PDF with decks export, and how the animated flag in decks.json changes the export flags.

## Reference

- [The decks CLI](https://decks.steamfield.io/docs/reference/cli.md): Every decks command, from init and new to lint, shot and fact-extract, with its arguments and flags, plus the decks.json registry it reads.
- [decks.json](https://decks.steamfield.io/docs/reference/decks-json.md): The deck registry the decks command reads, its _config entry (decksDir, outDir, base) and the fields of a deck entry.
- [theme.json tokens](https://decks.steamfield.io/docs/reference/theme-json-tokens.md): Every group in packages/decks/theme/default.json and the --od-* CSS variable each token becomes.
- [Components](https://decks.steamfield.io/docs/reference/components.md): The components slidev-addon-decks auto-imports in every deck, by family, and its import paths.