FrameSeq

FrameSeq documentation#

Three pages get a talk written: install FrameSeq, copy the page you need, then revise it. Everything else is here for the moment a slide asks for it.

  1. Getting started — a project, the first slides, a preview, an export.
  2. Recipes — a complete slide for each page a talk needs, with the result beside it.
  3. Revising a talk — what a second draft costs, edit by edit.

You can also explore the Live Gallery or edit the Online Playground before installing anything.

A Chinese translation of this reading path is at 中文文档.

Write slides#

The model behind the recipes, one subject at a time.

  • Document model — How presentation(), slide(), objects, and the active region fit together.
  • Content — Text, lists, images, code, formulas, metrics, cards, and groups.
  • Layout — Normal flow, split pages, grids, local grids, region paths, and canvas.
  • Diagrams — Region paths, automatic rows and columns, names, and connectors that follow their objects.
  • Shapes and connectors — The primitives a diagram is built from: rectangles, circles, lines, and arrows.
  • Styling — Chainable modifiers, text roles, dimensions, Tailwind utilities, and inline styles.
  • Themes — Built-in themes, presentation-wide typography, CJK text, and custom tokens.

Typeset mathematics and tables#

Bring an external typesetter in for the fragments that need one.

  • Typst integration — Embed Typst fragments, or export the whole presentation as editable .typ source.
  • LaTeX integration — Compile existing LaTeX tables and fragments into presentation objects.

Check and generate#

Verify a deck before presenting it, and hand the format to an agent.

  • Layout checks — Detect empty pages, overflow, clipped text, small type, and mistyped region paths.
  • Generate with AI — Give an agent the FrameSeq contract and iterate from layout diagnostics.

Present and export#

Deliver the talk and hand the file over afterwards.

  • Presenter and remote — Notes, next-slide preview, timer, synchronised controls, and a phone remote.
  • Deploy HTML — Publish a static presentation, use GitHub Pages, or build one portable file.
  • Export PowerPoint — Editable hybrid PPTX or pixel-faithful flattened slides.

Editor and command line#

Drive FrameSeq from the tools you already use.

  • VS Code extension — Split view, slide navigation, diagnostics, and export commands.
  • CLI reference — Development, remote control, HTML, PDF, PPTX, Typst, inspection, and checking.

Reference#

Look something up. Not part of the reading path.

  • Function reference — What each authoring function creates, its signature, parameters, and return value.
  • API reference — Exact TypeScript overloads, interfaces, and every public builder method.
  • Advanced composition — The uppercase object API and lower-level components.
  • Changelog — User-visible changes across releases.
  • Release automation — npm Trusted Publishing and the version-tag workflow.

The documentation tracks the latest published FrameSeq release.