markdown-presentation

A simple presentation tool that turns markdown files into a static HTML slideshow.

Layout

presentations/
  presentation-one/
    config.json
    01-title1.md
    02-title2.md
  presentation-two/
    config.json
    01-title1.md
    02-title2.md

Each folder under presentations/ is one deck. Each markdown file is one slide. The leading number in the filename (01, 02, …) controls slide order.

Config

Add a config.json next to the slides:

{
  "title": "Presentation One",
  "theme": "dark",
  "scale": 1.15,
  "sidebar": true
}

• theme — one of default, dark, ocean, sunset (CSS files in themes/)
• scale — multiplier for the slide font size
• codeTheme — optional Shiki theme for fenced code blocks (for example github-dark). If omitted, a theme is chosen from the deck theme.
• sidebar — true to show a left sidebar with numbered links to every slide. Defaults to false.

Build

npm install
npm run build

The script copies the folder structure into public/ as HTML, wires previous/next links in each slide footer, and writes public/index.html with links to every deck.

npm start

builds the site and serves public/.