Markdown in, presentation out.
One markdown file is the whole deck.
Present, build to static HTML, or export a PDF.
$
npx @exor404/mdslides
$
npm i -D @exor404/mdslides
$
npx mdslides ./deck
$
pnpm add -D @exor404/mdslides
$
pnpm exec mdslides ./deck
$
yarn add -D @exor404/mdslides
$
yarn mdslides ./deck
$
npm i -g @exor404/mdslides
$
mdslides ./deck
- npm v0.1.3
- MIT
- Node 18+
Live deck
This whole deck is one markdown file.
The presentation below was produced by mdslides build from a single
slides.md — nothing staged, nothing faked. Click in and drive it with your
arrow keys.
- ←→ move
- O overview
- F fullscreen
- . black
fixtures/slides.md Install
Pick your package manager.
Five ways to get mdslides on your machine. The CLI binary is always called mdslides.
Install
-
npx @exor404/mdslidesnpx -
npm i -D @exor404/mdslidesnpm -
pnpm add -D @exor404/mdslidespnpm -
yarn add -D @exor404/mdslidesyarn -
npm i -g @exor404/mdslidesglobal
Quick start
-
mdslides ./deck# present (live-reload dev server) -
mdslides build ./deck# static build → ./deck/dist/ -
mdslides export ./deck# deck.pdf — one page per slide
CLI
One binary, four verbs.
Point mdslides at a folder or a single .md file. No verb means present.
| Command | What it does |
|---|---|
dev | Present in a live-reload dev server (default if the verb is omitted) |
build | Static build → a self-contained <folder>/dist/ |
preview | Serve the built dist/ locally |
export | Render the deck to a PDF — one page per slide |
Presenter keys
→ · space · PageDn | next slide / reveal next fragment |
← · PageUp | previous |
O | overview grid — click a slide to jump |
F | fullscreen |
. | black the screen |
? | help |