Skip to main content

User guide

Write and present Seminar decks in MDX: Markdown with directives, attributes, and React components. Set up a project, preview it as you edit, and present it with notes, slide previews, and navigation controls.

To build your own components, plugins, or themes, see Developers.

Seminar is a proof of concept, so the syntax may still change.

Getting started​

  1. Getting started: create a project, edit your slides, and build a presentation to share.
  2. Editing and live preview: work in your editor or with a coding agent while the deck updates in the browser.

Writing decks​

What every deck can use, provided by @seminar/core and @seminar/mdx:

  1. Decks and slides: the deck file, its frontmatter, and how headings turn into slides.
  2. Content: lists, paragraphs, images, math, code, notes, and React components on slides, and naming elements on a slide.
  3. Steps: revealing content step by step, and how steps look before and after their turn.
  4. Recaps and includes: showing a slide again, and reusing slides of other decks.

Presenting​

Presentation controls cover navigation with the keyboard, mouse, and touch; the overview and table of contents; presenter notes, previews, timers, and pointer mirroring.

Plugins​

Plugins extend Seminar with additional slide components, syntax, and compiler features. You can also develop your own.

  1. Elements with @seminar/elements: callouts that point at content and columns for content side by side.
  2. Math with @seminar/plugin-mathjax: writing math, fonts, and macros.
  3. Diagrams with @seminar/plugin-pele: Mermaid diagrams in the font and colors of the theme.
  4. Highlighting code with @seminar/plugin-shiki: themes, and other languages.