Getting Started

Requirements

• Node.js 20+
• npm
• uv for docs work

Install and run

npm install
npm run dev

The Vite app runs on http://localhost:3000.

Open a deck from your computer

Open http://localhost:3000 and use the local deck loader.

Choose the folder that contains:

• your presentation JSON
• any relative images or background assets used by that JSON

If the selected folder contains multiple JSON files, the app will let you choose which one to open.

Open a URL-backed deck

Built-in example:

http://localhost:3000/?presentation=./examples/hello-world.json

CLI-backed local file:

npm run present -- ~/slides/demo.json

Repo-hosted deck from public/:

http://localhost:3000/?presentation=./public/my-deck.json

Validate before opening

npm run validate -- examples/image-demo.json
npm run validate -- examples/image-demo.json --json

Use --json when an agent or script needs structured output.

Build production output

npm run build
npm run preview

Build the docs site

npm run docs:serve
npm run docs:build

Both commands use uvx and MkDocs Material. The generated site is written to site/.

Docs theme

The documentation site includes:

• light mode
• dark mode
• a system-following mode via the palette toggle in the header