Meowland docs
Workbench

Package guide

meowslides

The presentation engine: the player, pages and steps, reveals, media, presentation layouts and themes.

v0.1.0-alpha.0

Installation

bun add meowslides

Overview

MeowSlides is the presentation package. It owns the player, pages and steps, the reveal mechanism, the media lifecycle, the presentation layouts and themes, and the trusted local MDX authoring entry point. It depends on Meowtail, MeowJSX and MeowCSS in one direction only; Meowtail does not depend on it.

What a slide is

A slide is data: a title, some content and the elements that reveal in a step.

tsx
import { Presentation, Reveal, type SlideDefinition } from "meowslides";

const deck: SlideDefinition[] = [
  {
    id: "opening",
    layout: "title",
    content: [{ type: "text", text: "One render graph" }],
  },
  {
    id: "detail",
    layout: "default",
    content: [
      { type: "text", text: "The next point" },
      { type: "reveal", content: [{ type: "text", text: "arrives on a step" }] },
    ],
  },
];

Trust boundary

MDX slides are trusted local code: the authoring entry point compiles a file the author already owns. Arbitrary uploaded or generated text is not executed; it is rendered as data.

Presentation workbench

Open the presentation workbench

The presentation workbench runs the stories the slides package declares, in the presentation theme.