Documentation

Find the page that matches your situation. Every row says which question it answers.

Start here

You are evaluating Narro or building your first deck.

Reference

You are writing a deck and need the exact name of something.

Guides

The deck works and you want it to do more, or to stop doing something.

Reading this as an AI agent?

Start with llms.txt. If you can only afford one fetch, take llms-full.txt instead β€” it is every page in one response.

  • /llms.txt β€” the index: install commands, the closed sets, and every page with the question it answers.
  • /llms-full.txt β€” all of the above with every page inlined. One fetch, no follow-ups.
  • /catalog.json β€” the closed sets. Every valid layout, theme, colour scheme, transition, font preset, template, and component name. If a name is not in here it does not exist, and inventing one produces a deck that builds and renders wrong.
  • /components.json β€” every component's props, read out of the TypeScript types rather than transcribed.
  • Any page, as markdown: append .md to its URL β€” /docs/markdown-mode.md. Same content, a fraction of the tokens, no markup to parse back out.
  • deck-frontmatter.schema.json and slide-frontmatter.schema.json β€” the frontmatter contract, generated from the parser's own definitions.
  • No web access? npm i -D @getnarro/docs ships all of the above through the registry that already installed your packages.
  • Then check your work: npx @getnarro/cli check deck.md. Documentation tells you what is possible; the checker tells you whether what you wrote is correct. See Rules for AI agents.
IntroductionWhat is Narro, and should I be writing markdown or React?
InstallationWhat do I install, and what does the project look like afterwards?
First DeckWhat does a working React deck look like, end to end?
Markdown ModeHow do I split a slide, style one word, or reveal a line β€” without leaving the markdown file?
Writing AI PromptsWhat do I tell an AI so the deck it writes actually builds?
Rules for AI AgentsWhat do I paste into my repo so an agent stops writing decks that build wrong?
React APIWhich component or hook do I import, and what does it take?
CLIWhich command do I run, and what are its flags?
Markdown APIHow do I read, edit, or validate a deck file from my own code instead of by hand?
Component ReferenceWhat props does this component take, and which package do I import it from?
Verifying a deckHow do I know my deck is actually correct?
AnimationHow do I reveal a list one line at a time, or move between slides with something other than a cut?
NavigationHow does the audience move through the deck, and how do I present it?
Canvas & PositioningHow do I put something at an exact position instead of in the flow?
Images & MediaHow do I use an image as a background, tint it, or embed a video?
ArchitectureWhich package owns what, and why is the seam where it is?
Transform ModeHow do I zoom and pan across one big canvas instead of cutting between slides?
Import & ExportHow do I get this deck out as PPTX, PDF, or one file I can email?
AI IntegrationHow do I wire an AI assistant up to Narro so it can write and build decks?
ThemingHow do I change the colours, fonts, and overall look of a deck?
Deck TemplatesHow do I define one house style with named layouts my slides can reference, like a PowerPoint master?
TroubleshootingSomething is wrong with my deck. What is it, and how do I fix it?
LimitationsWhat can't Narro do, and what do I do instead?