@honeydeck/honeydeck
v0.4.0
Published
MDX and React-based presentation framework for AI-friendly slide decks.
Downloads
857
Maintainers
Readme
Honeydeck
MDX and React-based presentation framework. Start with plain Markdown, grow to interactive React components.
Honeydeck helps you create polished, interactive presentations from plain-text MDX. Write slides in Markdown, add React components when you need them, and present with built-in layouts, speaker notes, presenter mode, and PDF export.
Quick start
npx @honeydeck/honeydeck init --name awesome-talk
cd awesome-talk
npm run devOpen the local URL printed by the dev server, edit deck.mdx, and your slides update instantly.
Decks are plain MDX files separated into slides with ---; see the first deck example in Getting started.
Documentation
- Getting started - first deck, first commands, and the shortest path to presenting
- Deeper dive - CLI options, authoring patterns, imports, themes, architecture, and agent skills
- Slides - separators, multiple files, layouts, and assets
- Configuration - deck-level and slide-level frontmatter
- Steps and reveals - timeline, reveal groups, code steps, and PDF behavior
- Components - core Honeydeck components such as
BrowserFrameandKeyboard - Customization - themes, layout sets, Tailwind tokens, custom layouts, and layout demos
- Navigation - keyboard, touch, overview mode, and URL state
- Mobile and touch - mobile controls, touch gestures, and pinch zoom
- Presenter mode - notes, presenter window, sync, and mobile behavior
- PDF export - options, color modes, and step handling
- Local development - running Honeydeck from this repository
- Skills - optional agent skills for authoring, writing, and migration help
- Slidev migration - moving from Slidev with the bundled agent skill
Common commands
honeydeck dev # start dev server on port 4200
honeydeck dev --open # start and open the browser
honeydeck dev --deck talk.mdx # use a custom deck entry file
honeydeck build # build a static SPA into dist/
honeydeck pdf # export deck.pdf
honeydeck pdf --steps all # export every timeline step
honeydeck skill # install optional Honeydeck agent skillsHoneydeck is built with MDX, React, Vite, and Tailwind v4.
