Getting Started

Install Deckup

Install Deckup in your presentation project and create a slides/ directory:

npm install -D deckup
mkdir -p slides

Create your first deck

Create slides/deck.mdx:

---
title: My first Deckup deck
---

# My first Deckup deck

An Astro-native presentation.

---

# A content slide

- Write slides in Markdown.
- Start a new slide with a horizontal rule.
- Add layouts when the presentation needs more structure.

The first page uses the cover layout by default. Later pages use default.

Preview the deck

Start the local preview server:

npx deckup open slides/deck.mdx --open

Use the arrow keys or the on-screen controls to move between slides.

Export the deck

Build static HTML and assets:

npx deckup build slides/deck.mdx --format html

Export a PDF (the default build format):

npx deckup build slides/deck.mdx

Render every slide as a fixed 1600×900 PNG:

npx deckup build slides/deck.mdx --format png

The default output name comes from the deck filename. Use --out to choose another file or directory.

Next steps

• Read Writing Slides for a practical authoring workflow.
• Check the Syntax reference for exact Astro, MDX, layout, and slot rules.
• Compare the built-in themes.