Get started

Start building your first story.

Install the library, write a deck the way you write software, and render it as a presentation, a PDF or a film.

Step one

Install

Add the packages
npm i @getnarro/core @getnarro/cli

Adds @getnarro/core and the CLI. React 18+ and Node 20+.

Or scaffold a project 
npm create narro@latest my-deck

Gives you a working deck, a dev script and an export script to edit rather than a blank file to fill.

The loop

How it works

  1. 01

    Write it as source

    A deck is a markdown file or a React component — in your repo, in your editor, under review like everything else you ship.

  2. 02

    Present it from the stage

    `narro dev` opens the deck with hot reload, presenter view, speaker notes and a clock.

  3. 03

    Export what the room needs

    The same source becomes a static build, a PDF, a PowerPoint or a video. Nothing gets re-laid-out by hand.

What you get

Capabilities

Story and structure

  • Beats, holds and reveals
  • Layouts and slide masters
  • Markdown or MDX authoring

Web-native slides

  • React components as slides
  • SVG, canvas and WebGL
  • State-driven interaction

Developer control

  • Hooks into the deck’s state
  • Your own layouts and themes
  • Deterministic video render
Docs

Start here

You are evaluating Narro or building your first deck.

Introduction

What Narro is, and which of its two authoring modes you want

4 min

Installation

Get a deck running, in either mode

5 min

First Deck

Build a three-slide React deck end to end

2 min

Markdown Mode

The full markdown and MDX dialect — slides, layouts, Tailwind attributes, fragments

30 min

Writing AI Prompts

How to brief an AI assistant so the deck it produces actually builds

3 min

Rules for AI Agents

Copy-paste contracts for your AGENTS.md, CLAUDE.md, or .cursor/rules

13 min
Docs

Reference

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

React API

Presentation, Slide, SlideContent, Notes, and the navigation hooks

3 min

CLI

narro new, dev, build, export, import, bundle, preview, themes

12 min

Markdown API

Reading, editing, validating, and compiling a deck from code — the four @getnarro/markdown entry points

11 min

Component Reference

Every component in @getnarro/core and @getnarro/shared-ui, with its props

80 min
Docs

Guides

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

Verifying a deck

What each check sees, what it cannot see, and the one gate to run before you ship

7 min

Animation

Fragments, transitions, and the motion primitives

4 min

Navigation

Keyboard, mouse, touch, URL routing, overview mode, and the presenter view

2 min

Canvas & Positioning

Place elements at exact coordinates with Canvas, CanvasElement, and CanvasShape

1 min

Images & Media

Filters, overlays, backgrounds, video, and embeds

2 min

Architecture

How the packages fit together and why the seams are where they are

2 min

Zooming canvas

One plane, many framings — a camera that moves instead of cutting

11 min

Transform Mode

Prezi-style spatial navigation with TransformSlide

3 min

Import & Export

PPTX, PDF, Google Slides, static sites, and single-file HTML

2 min

Video

Render a composition to MP4 — narration-derived timing, a scene cache, the director's pass, any voice, scripted footage, and citations that ship with the video

17 min

Recording a web app

Record your product into a cast that replays as real DOM — sharp at any size, selectable, embeddable in a slide or a website, and kilobytes rather than megabytes

9 min

Embedding a replay

Put a recording of your app into a React, Preact, Astro, Vue, Svelte or plain HTML page — one tag, one import, and a component that renders on a server

16 min

Terminal

Record a terminal session as text, render it as a GIF, an SVG, a still, a slide or a video, embed it in any page — and check in CI that the demo still says what it claims

8 min

AI Integration

The MCP server, and how to give any assistant accurate Narro docs

6 min

Theming

Themes, colour schemes, fonts, and per-deck styling

5 min

Deck Templates

The slide master for markdown mode — one file of tokens, chrome, and layouts addressed by id

8 min

Troubleshooting

Symptoms, what causes them, and the fix — including the failures that produce no error

11 min

Limitations

What Narro cannot do, and what to reach for instead

15 min

Ready to build your first story?

Write your first deck Start from a template