Getting started — Honeydeck docs
Getting started 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 Create a deck: Open the local URL printed by the dev server, edit deck.mdx , and your slides update instantly. Build or export when you are ready: Running honeydeck with no subcommand shows CLI help. Your first deck Decks are MDX files. The first frontmatter block configures the deck and opening slide. Later separators start new slides. Use layout: to choose a slide layout. Built in layouts include Blank , Default , Cover , Section , TwoCol , Image , ImageLeft , and ImageRight . What Honeydeck gives you MDX slides with GitHub flavored Markdown Vite dev/build with hot reload Built in layouts and theme tokens Tailwind v4 friendly styling Reveal steps and code step through Presenter mode with speaker notes Overview mode, keyboard/touch navigation, and URL state PDF export through headless Chromium Optional Honeydeck agent skills for writing and migration help Common commands Where to go next Next steps /docs/next steps CLI options, authoring patterns, imports, themes, architecture, and agent skills in one follow up guide Slides /docs/slides separators, multiple files, layouts, and assets Configuration /docs/configuration deck level and slide level frontmatter Steps and reveals /docs/steps and reveals timeline, reveal groups, code steps, and PDF behavior Components /docs/components core Honeydeck components such as BrowserFrame and Keyboard Kits /docs/kits themes, layout sets, Tailwind tokens, and third party kits Kit authoring /docs/kit authoring layout maps, layout props, demos, and design tokens for kit authors Navigation /docs/navigation keyboard, touch, overview mode, and URL state Mobile and touch /docs/mobile mobile controls, touch gestures, and pinch zoom Presenter mode /docs/presenter mode notes, presenter window, sync, and mobile behavior PDF export /docs/pdf export options, color modes, and step handling Local development /docs/local development running Honeydeck from this repository Slidev migration /docs/slidev migration moving from Slidev with the bundled agent skill Learn inside a running deck During development, open the runtime reference pages to see: theme token names and live computed values layout previews with copyable usage snippets built in component docs Honeydeck is built with MDX, React, Vite, and Tailwind v4.