ippon-slides documentation
This is the full documentation for ippon, a CLI that turns Markdown into “one message per slide” decks.
For an overview and installation, see the repository README.
The Japanese version is here.
The ideas behind the design, and how ippon differs from Marp, Slidev and reveal.js, are in Why ippon.
Contents
- Getting started — installation, quick start, and the basic workflow
- Markdown syntax — slide breaks, directives, two columns, code, and tables
- HTTP playground (
::http::) — show an HTTP response on a slide - Use your phone as a remote (
ippon serve) — connect with a QR code to change slides and read notes - Presenter view and controls — keys, timer, and speaker notes during a talk
- Change the look —
--cssand CSS variables - CLI reference — all commands and options
- Why ippon — the ideas behind it, and how it differs from Marp, Slidev and reveal.js
- FAQ — PDF, offline use, PPTX, phone control and more
Features
- Outputs a single HTML file (all CSS and JS inlined). One file to hand out and share.
- Zero runtime dependencies. PDF output drives your local Chrome directly.
- 16:9 PDF output.
- Built-in HTTP playground, phone remote, and presenter view.