Skip to content
kadalccPublic

About

Build it. Rehearse it. Own the room. Kadal Deck has your back from first idea to last applause: AI to build it, tools to rehearse it, and a live room to own it. Open-source MDX slides, a phone remote, polls and Q&A from the audience's phones.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

380 Commits

Folders and files

Kadal Deck

Build it. Rehearse it. Own the room.

Kadal Deck has your back from the first idea to the last applause: AI that drafts with you, rehearsal with a voice and a timeline, a teleprompter and your phone as the clicker, and a live room that keeps every seat in it — polls, quizzes, Q&A and reactions.

npm version npm downloads a month CI Licence: AGPL-3.0-or-later VS Code extension Sponsor Kadal Deck

A talk is more than its slides. You need an outline that holds, slides that look the part, a few run-throughs out loud, the right notes in front of you on the day, and a room that stays with you to the end. Kadal Deck is built for all of it. You write the deck in one deck.mdx file, with AI beside you if you want it; you rehearse it with the deck reading your notes and keeping time; you present it with your phone in your hand; and the audience joins from theirs to vote, ask and react. The engine is open source, and hosting is free for public decks.

Kadal Deck on stage: the tour's title slide, Build it. Rehearse it. Own the room., on a big screen in front of an audience, the AI Assistant adding a poll slide, the speaker's phone as the remote with the notes, and an audience phone on the same slide answering a live poll

Take the tour →
A deck that shows every feature, built with Kadal Deck. Open it and press ?.

Get started · Docs · Themes · Pro library · Hosting · Changelog


Build it

Start from an idea, not a blank slide.

  • ✦ An AI assistant that drafts with you. In the builder on deck.kadal.cc, tell it about the talk ("turn my notes into eight slides", "add a poll after the intro") and it writes and revises the deck slide by slide, checks its work against the compiler, and answers the comments on your draft. Every change is a revision you can undo. It runs on your own key from OpenAI, Anthropic, Google or OpenRouter.
  • ✦ Your own agent, too. The Agent Skill and the MCP server teach Claude Code, Cursor, VS Code or any MCP client the format, then let it outline, write slides, lint them, render them to look at its own work, and fix what it sees. The hosted MCP server brings your published decks to Claude, ChatGPT and Cursor.
  • Write where you like. Markdown and MDX in your editor, with the VS Code extension and the kadal-deck CLI, or in the browser builder: edit right on the slide, and drop in emoji, icons, stickers, shapes, free photos, GIFs and memes from the media panel.
  • Look the part. 17 themes in light and dark, 28 built-in backgrounds, and the Pro library of 95 backgrounds and layouts.

Rehearse it

Practise out loud until it's yours.

  • The deck reads your notes aloud and turns its own pages as it goes, in the browser's voice or the Kokoro AI voice running in your browser. Narration shows every chapter and slide on a timeline, so you hear how long the talk really runs.
  • A plan for every slide. Give each slide a time; the timer's bar marks where you should be, and a pacing badge says how far ahead or behind you are, so you find the long parts before the day.
  • A teleprompter and the presenter view. Your notes, big, on the screen you read from, following each click; and beside the slide, the notes, the next slide and the timer.
  • ✦ Copilot can quiz you on your notes while you rehearse a hosted deck.
  • Glossary cards. The first mention of a term links to its definition, so you, and later the room, never lose the thread.

Present it

Walk on stage with everything at your fingertips.

The presenter view of the tour, in the dark scheme, on slide 149, a live poll: the speaker notes on the left with the next slide under them, the current slide with the poll bars filling in the middle, and on the right the Room tab with the QR code and the join link, 7 watching and the pace votes, beside the Q&A, Polls and Copilot tabs and Report a bug, Request a feature and Send feedback. Along the top: the timer with its pacing badge, the rehearsal menu and every tool, from Draw and Spotlight to Teleprompter, Camera, Record and Phone remote; along the bottom, the rehearsal timeline
The presenter view: your notes, the next slide, a timer with pacing, the room beside you and every tool on one screen. Press S in any deck.

  • The presenter view: notes, timer, next slide, drawing, camera and recording, and a share window for video calls.
  • Your phone is the remote. A live copy of the slide, your notes, the timer, a laser and a pen, and an air pointer you aim by moving the phone, paired by a QR code. It works from a static host too. Phone remote
  • ✦ Copilot in the presenter view of a hosted deck. Ask it to go to the results slide, black out the screen, circle the total on this slide, or tell you what's in your notes here.
  • Laser, spotlight, pen, zoom, blackout. A built deck presents offline, and exports to PDF, PNG and PPTX.

Own the room

Keep every seat with you.

The audience page on a phone, joined to the same slide of the tour: Live, 7 here, the presenter's current slide, Slide 149 of 154, a row of reactions, and the open poll with this phone's vote ticked and the room's results beside each answer; tabs along the bottom for pace, ask, polls, notes and mine
The audience page, on the same poll as the presenter view above: scan the QR code, no app, no account. The slide stays in step with you, or roams ahead and catches up.

  • The audience joins from their phones, from a link or the QR code on your slide, with no app and no sign-in, and follows along. The room runs on deck.kadal.cc or on your own server. The live room
  • Live polls, quizzes, word clouds, Q&A with upvotes, reactions, a pace check and a raised hand, all written as components in your deck.
  • Afterwards, see how it went. Every hosted deck counts its views; paid plans add the time spent on each slide, and Pro and Team keep the sessions and their peak audience, the questions, reactions and poll results. Analytics

Open source, on your side. The engine is AGPL. One deck.mdx, in git, published with one command. AI on your own key: nothing sold, no lock-in. Hosting is free for public decks, with paid plans from $4 a month.

Start in 30 seconds

You need Node 20.19 or later.

npm create @kadal/deck@latest my-talk
cd my-talk && npm install
npm run dev        # http://localhost:5173: edit deck.mdx and the slide you're on updates in place

A deck is one deck.mdx file: Markdown, split into slides at ---, with components when you need them.

---
title: Hello, room
theme: ocean
---

# Hello, room

---

## One point at a time

<Clicks>

- Slides split at `---`; a slide below this one starts at `----`
- Code steps line by line, and the notes follow your clicks

</Clicks>

---

<Poll id="lunch" question="Lunch?" options={["Dosa", "Biryani", "Both"]} />

When it's ready:

npx kadal-deck build      # dist/: a static site for any host, works offline
npx kadal-deck export     # PDF in export/ (add --png or --pptx)
npx kadal-deck publish    # a URL on deck.kadal.cc with a live room (free plan)

Rather not install anything? Write it in the builder on deck.kadal.cc. Already have a Slidev or reveal.js deck? npx kadal-deck import slidev slides.md or npx kadal-deck import reveal index.html converts it and writes a report of anything that didn't carry over.

Everything in the engine

Four slides from the tour, in the dark scheme: a hand-drawn diagram beside a Mermaid chart and an Excalidraw file, a grid of the 28 built-in backgrounds running, one item from each genre of the Pro library, and eleven framework islands each counting how long it has been alive

Writing (docs) MDX slides, 19 layouts with named slots, frontmatter per slide, src: includes, glossary terms the compiler links on first mention
Clicks and motion (docs) <Click>, <Clicks>, at="+2", notes that follow your clicks, 7 transitions (a different one in and out if you like), auto-animate, <Motion>
Code (docs) Shiki highlighting stepped line by line, magic move, Monaco editors, runnable JS/TS/Python, TwoSlash hovers, code groups, snippet imports
Maths, diagrams, sketches (docs) KaTeX at build time, Mermaid in the deck's colours, Excalidraw drawings revealed region by region
Looks (docs) 17 themes in light and dark, 28 built-in backgrounds (most of them animated), the Pro library of 95 backgrounds and layouts on deck.kadal.cc, 200,000 icons through Iconify, Tailwind
Any framework (docs) React and web components built in; Vue, Svelte, Solid, Preact, Qwik, Angular, Fresh, Rust/WebAssembly and Python as islands, each loaded only when its slide appears
Rehearsing (docs) Narration that reads the notes and turns the pages, per-slide timings with a pacing badge, a teleprompter window, glossary cards
Presenting (docs) Presenter view with notes, timer and next slide; drawing, laser, spotlight, blackout, camera, recording; a share window for video calls; a phone remote; vim keys
The live room (docs) The audience follows on their phones: reactions, questions with upvotes, polls, word clouds, timed quizzes, a pace dial and a raised hand
Export (docs) PDF, PNG and PPTX, with or without each click step; a static build that works offline

Backgrounds and layouts

The Pro library. 95 backgrounds and layouts in 15 genres — board-pack covers, KPI boards, magazine spreads, terminal covers, lecture outlines, synthwave grids, wedding invitations — each in light and dark, each wearing your deck's theme. One line of frontmatter picks one:

---
layout: pro/kpi-board
background: pro/neon-drift
---
Executive Cover, a Pro layout from the corporate genre
layout: pro/exec-cover
KPI Board, a Pro layout from the finance genre
layout: pro/kpi-board
Pull Quote, a Pro layout from the editorial genre
layout: pro/pull-quote
Terminal Cover, a Pro layout from the developer genre
layout: pro/terminal-cover
Neon Drift, a Pro background from the gaming genre
background: pro/neon-drift
Ridges, a Pro background from the nature genre
background: pro/ridges
Riso Shapes, a Pro background from the creative genre
background: pro/riso-shapes
Breathe, a Pro background from the health genre
background: pro/breathe

The library renders on decks published to deck.kadal.cc from a Pro or Team workspace. Anywhere else — a static build on your own host, or the free plan — a pro/ name falls back to the theme's own background and the default layout, so the slide still reads; only the dev server says why, in a small chip. Every item, moving, in light and dark: deck.kadal.cc/library.

Built in, free everywhere. 28 backgrounds ship with the engine — background: aurora, or <Background name="aurora" /> inside a slide — most of them animated, all paused off-slide and still under reduced motion. A few of them:

The gradient-mesh background: slow, drifting, blurred colour blobs
background: gradient-mesh
The aurora background: soft northern-lights bands
background: aurora
The waves background: layered noise waves
background: waves
The glows background: large slow glows of colour
background: glows
The constellation background: points joined to their near neighbours, drifting
background: constellation
The globe background: a wire globe, turning slowly
background: globe

Themes

Sixteen themes, each in light and dark where it makes sense. Three are built in; the rest are packages you install and name in the headmatter (theme: ocean). Browse them all at deck.kadal.cc/themes.

Minimal theme
minimal · built in
RLA theme
rla · built in
Stack theme
stack · built in
Ocean theme
ocean
Brand theme
brand
Crayon theme
crayon
Folio theme
folio
Lecture theme
lecture
Neon theme
neon
Swiss theme
swiss
Terminal theme
terminal
Classic theme
classic
Seriph theme
seriph
Crisp theme
crisp
Bricks theme
bricks
Shibainu theme
shibainu

Classic, seriph, crisp, bricks and shibainu are ports of the official Slidev themes, MIT-licensed, with credit to their authors in each package. npm create @kadal/deck@latest -- --theme <name> starts a theme of your own; the contract is THEMES.md.

For AI agents

Kadal Deck is built to be written by an agent as well as by you: a skill that teaches the format, an MCP server that edits slides line by line and renders them so the agent can look at its work, and a CLI whose every command answers in JSON. Guide: AI agents.

/plugin marketplace add kadalcc/deck          # Claude Code: the skill and the MCP server together
/plugin install kadal-deck@kadal-deck
npx skills add kadalcc/deck                              # the skill alone, for any agent (skills/kadal-deck)
claude mcp add kadal-deck -- npx -y @kadal/deck mcp      # the MCP server alone

For Claude Desktop, Cursor and VS Code, point the client at npx -y @kadal/deck mcp. The server works in the folder it starts in (or --dir <path>) and never reads or writes outside it unless started with --allow-outside.

MCP tools
deck_reference, deck_frontmatter_schema every component, layout, background and option, from the engine's own catalog
deck_create, deck_outline, deck_read_slide, deck_check scaffold, read the deck as structure, lint it
slide_add, slide_update, slide_remove, slide_move, deck_update_frontmatter, notes_set edits that change only that slide's lines, linted on the spot
slide_render, deck_preview PNGs of slides from a dev server kept running between calls, and a live URL
deck_build, deck_export, deck_publish a static site, PDF/PNG/PPTX, and a published deck
media_search, media_trending, media_used icons, emoji, stickers, GIFs, memes, meme templates and Kadal's own library, each with the MDX to insert and its credit (credits: true lists them all on a Credits slide)

Hosted decks, from any agent. The hosted service runs a remote MCP server at https://deck.kadal.cc/mcp (OAuth; you pick one workspace and can make the connection read-only). It lists and inspects your published decks, reads a talk in progress (current slide, polls, questions by votes), changes titles, visibility and passcodes, rolls back versions, makes share links, and quick-edits and publishes decks through the web builder without ever overwriting newer work. Add it as a custom connector in Claude, ChatGPT or Cursor, or with claude mcp add --transport http kadal-deck-hosted https://deck.kadal.cc/mcp.

Kadal Deck MCP connector – tool definition quality and endpoint health on Glama

For scripts: kadal-deck check (exit 1 on errors), kadal-deck screenshot, kadal-deck info [topic], and --json on every command. Exit codes: 0 ok, 1 failed, 2 usage, 3 not signed in, 4 missing prerequisite. @kadal/deck/catalog is everything a deck can use as data, @kadal/deck/authoring reads, lints and edits a deck as text, and @kadal/deck/schema/frontmatter.json is the JSON Schema for frontmatter.

In your editor

  • VS Code extension (Marketplace): a live preview that follows your cursor, a slide outline you drag to reorder, IntelliSense for every setting and component, the deck's checks as problems, and formatting.
  • @kadal/prettier-plugin: Prettier for deck files, in any editor that runs Prettier. kadal-deck format runs the same formatter with no setup.
  • In the browser: press E in kadal-deck dev for a side editor on the slide you're on.

How it works

deck.mdx goes through the Vite plugin, one module per slide, into the Deck runtime, which joins the live room over a WebSocket; the room keeps the presenter view, the projector and the audience's phones in step

Each slide is its own module, so an edit re-renders one slide, not the deck. The drawing is an Excalidraw file, drawn with the same sketch DSL a slide's <Sketch> uses.

Hosted or self-hosted

Writing, presenting, the presenter view, export and a static build need nothing but this engine, and stay free. The live room needs a server holding a WebSocket per deck.

  • deck.kadal.cc: npx kadal-deck publish gives the deck a URL, a live room, analytics, passcodes, version history and teams, and quick edit on the web that kadal-deck pull merges back into your files slide by slide. There is a free plan, and the paid plans fund the engine.
  • Your own host: kadal-deck build output runs on any static host (kadal-deck ci writes the deploy files for GitHub Pages, Netlify, Vercel, Cloudflare or Docker). The room protocol is typed in @kadal/deck/protocol and documented endpoint by endpoint, and kadal-deck relay gives a static build the phone remote.

Packages

Package Version
@kadal/deck npm The engine: MDX compiler and Vite plugin, runtime, components, themes, live client, export, the kadal-deck CLI and MCP server
@kadal/create-deck npm npm create @kadal/deck@latest: a new deck, theme or addon
@kadal/deck-vue, -svelte, -solid, -preact, -qwik, -angular, -fresh, -wasm, -python npm Framework renderers for islands
@kadal/theme-* (13 packages) npm The themes above
@kadal/prettier-plugin npm Prettier for deck files
Kadal Deck for VS Code Marketplace Preview, outline, IntelliSense, checks and formatting
@kadal/deck-shell not on npm yet A prebuilt page that runs any deck.mdx compiled in the browser, for hosts and editors

All @kadal/* packages version together and are published from this repository's release workflow through npm trusted publishing, with provenance on each npm page. The VS Code extension is published by its own workflow.

Documentation

Getting started · Writing slides · Components · Configuration · CLI · Publishing · Writing a theme · Coming from Slidev

The engine's full reference, with every component and option, is in packages/deck/README.md, and npx kadal-deck info prints it in the terminal.

Licence

AGPL-3.0-or-later. Presenting with Kadal Deck, self-hosting your own decks, and embedding a deck in a site you publish trigger nothing; you owe nobody anything. If you run a modified engine as a network service, its users must be able to get your modified source.

Building a hosted or proprietary product on the engine without publishing your changes? A commercial licence removes the AGPL obligations: write to hello@kadal.cc. Details are in LICENSING.md. The five ported themes are MIT, and third-party notices are in THIRD_PARTY_NOTICES.md.

Contributing

A bug report with a small deck.mdx that reproduces it is the most useful thing you can send, and pull requests are welcome. CONTRIBUTING.md covers the setup (Bun 1.3+), the tests and the island verifier. Questions and ideas go to Discussions. Please follow the code of conduct, and report security issues privately as SECURITY.md describes.

Sponsors

Sponsorships pay for time on the open-source engine: issues, docs, new islands and the features you ask for. Sponsor Kadal Deck on GitHub; the tiers and what each one gets are on deck.kadal.cc/sponsor, and backers are listed in BACKERS.md. Companies can sponsor by invoice.

Your logo here: be the first company to sponsor Kadal Deck.

Made in Chennai by Kadal · deck.kadal.cc · hello@kadal.cc

About

Build it. Rehearse it. Own the room. Kadal Deck has your back from first idea to last applause: AI to build it, tools to rehearse it, and a live room to own it. Open-source MDX slides, a phone remote, polls and Q&A from the audience's phones.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages