@apisurf/deckui
v0.1.2
Published
deckui — build and preview the presentations that deck writes: render a deck into static HTML, or serve it locally.
Maintainers
Readme
@apisurf/deckui
Build and preview the presentations that deck writes. deck changes
the deck; this renders it.
pnpm add -g @apisurf/deckui
deckui ls # which decks are here, and what is in them
deckui build q3-review # render it into ./dist/q3-review
deckui serve q3-review # build it and serve it over HTTP
deckui open ./dist/q3-review # serve a folder that is already builtGiven no deck, build and serve use the only one there is, and print the list
when there is more than one.
deckui build reduces presentation.json to a JSON snapshot and hands that to
the bundled Astro theme, which writes one HTML page, a 404 page, a stylesheet
and the diagram library. Then it copies images/ across.
The diagram library is written every time, about 3.5 MB of it, whether or not a slide holds a mermaid block. Only a deck that has a diagram loads it.
The output has no server requirement: open index.html, or point any static
file server at the folder. Arrow keys move between slides.
Nothing here writes to the deck. --snapshot-only stops at the JSON, which is
the seam any other renderer can read.
Start with deckui help, deckui help keys and deckui howto.
Full documentation: https://github.com/apisurf/deck#readme
