@apisurf/deck
v0.1.2
Published
deck — a presentation is a JSON list of markdown slides; deck writes it.
Maintainers
Readme
@apisurf/deck
A presentation is a JSON list of markdown slides. deck writes those files.
pnpm add -g @apisurf/deck
deck new deck "Quarterly Review" # a folder in the store, with a title slide
deck new slide --deck quarterly-review --content "## Where the time went"
deck ls slides --deck quarterly-review # the slides, numbered[
"# Quarterly review\n\nOctober",
"## Where the time went\n\n- Migrations\n- Meetings\n- Actual work"
]One string is one slide, in markdown; the order of the array is the order of the
talk. Decks live in ~/.apisurf/deck/<slug>/, globally — not per directory.
Images live in images/ inside the deck's own folder and are linked relatively;
a fenced mermaid block is drawn as a diagram.
Every command is about one record: new, ls, get, set, rm, mv, plus
cat for the markdown itself and img for the files hosted with a deck. Each
has a --json, except the two that hand over slide bodies.
Building and serving the deck is deckui, a separate command that reads
the same folder and never writes to it:
pnpm add -g @apisurf/deckui
deckui serve quarterly-reviewThey are two packages so that nothing an agent needs in order to write a slide drags a static site generator along with it.
Start with deck help, deck help format and deck howto.
Full documentation: https://github.com/apisurf/deck#readme
