Bundeck 🐰

A zero-config tool for generating HTML slides from Markdown. Bundeck runs on Bun and provides automatic layout adjustment, speaker notes, and presenter mode.

Features

• Use Markdown directly as your slide source
• Automatically adjust font sizes to match content density
• Use extended syntax for classes, columns, and image styles
• Live preview with the built-in development server (HMR)
• Presenter mode with notes, a timer, and a laser pointer
• Static HTML builds and a programmatic API for Bun

Quick Start

Bun 1.4.0 or later is required.

Install

bun add --dev bundeck

To run Bundeck without installing it, use bunx.

bunx bundeck presentation.md

Generate HTML

bundeck presentation.md

This generates presentation.html in the same directory as the input file. You can also specify an output path.

bundeck presentation.md --output slides.html

Preview with the development server

bundeck serve presentation.md

• View mode: http://localhost:3000/
• Presenter mode: http://localhost:3000/presenter

Use --port to change the port.

bundeck serve presentation.md --port 8080

Example Input

---
title: My First Presentation
theme: default
aspectRatio: 16:9
fontSize: M
---

# Hello {.center}

Write slides in Markdown.

---

## The Next Slide

- A bullet list
- Speaker notes

See the User Guide for the normal workflow and the Authoring Reference for the complete Markdown syntax.

Programmatic API

Bun applications can generate HTML directly and override presentation settings in code.

import { generateSlides } from "bundeck";

const html = await generateSlides("# Hello", {
  title: "My Presentation",
  theme: "dark",
  aspectRatio: "16:9",
  lang: "en",
  outputPath: "slides.html",
});

See the API reference for all available options.

Documentation

• Documentation index
• User guide — Installation, CLI usage, display modes, and introductory syntax
• Authoring reference — Complete Markdown syntax, classes, containers, and assets
• Layout behavior — Automatic sizing, overflow scaling, aspect ratios, and columns
• API reference — Functions, types, and extensions for Bun
• Developer guide — Setup, checks, and project structure
• Sample presentation — A presentation demonstrating Bundeck features
• Changelog
• Contributing guide
• Security policy

Development

bun install
bun run check
bun test
bun run build
bun run verify:package

See the developer guide for detailed development instructions.

License

MIT