Universe

Create project in app

Typst Universe License: MIT Typst version: >= 0.14.0 touying version: 0.7.4 Built-in themes

中文 | English

Academic presentation and note-taking templates built on touying. The package covers slide decks, handouts, speaker notes, and A4 notes from one Typst source. The visual theme is derived from Carlos-Mero/may under MIT.

Features

  • Universe template support: typst init @preview/xwysyy:0.4.0 creates a ready-to-compile deck.
  • Six built-in themes: sky, sunset, forest, midnight, violet, and graphite.
  • Custom theme dictionaries can be passed directly to theme, so users can customize colors without forking the package.
  • font, code-font, and lang are shared between slide and note mode; slides additionally take heading-font for the header title.
  • Touying handout mode, #speaker-note, and pdfpc export are documented with tagged source examples.
  • xwysyy-doc compiles one source as a 16:9 deck by default and as A4 notes with --input mode=note.
  • Eight semantic layout components (duo-slide, grid-slide, figure-slide, stat-slide, …) measure every block at compile time, distribute space fill-first, and export layout telemetry without hand-written #v() spacing.

Preview

Rendered previews are generated from the tagged source examples.

Slide Themes

sky sunset forest
Sky theme cover Sunset theme cover Forest theme cover
midnight violet graphite
Midnight theme cover Violet theme cover Graphite theme cover

Component Pages

Sky cover Sky components
Sky theme cover slide Sky theme textbox components
Sunset cover Sunset components
Sunset theme cover slide Sunset theme textbox components
Note title Note code Note table
Note mode title and TOC Note mode lists and code Note mode tables and quotes

Quick Start

Create a new project from the Universe template:

typst init @preview/xwysyy:0.4.0 my-talk
cd my-talk
typst compile main.typ

Use the package in an existing Typst project:

#import "@preview/xwysyy:0.4.0": *

#show: xwysyy-pre.with(
  theme: "sunset",
  config-info(
    title: [My Presentation Title],
    subtitle: [Subtitle],
    author: " ",
    date: datetime.today(),
    institution: " ",
  ),
)

#title-slide()
#outline-slide()

= Section Title

== Slide Title

Body text with *bold* and #red[red highlight].

#textbox(
  [*Module A*

  First column],

  [*Module B*

  Second column],
)

#end-slide(title: [Thank You!], body: [Questions?])

Themes

Select a built-in theme by name:

#show: xwysyy-pre.with(
  theme: "forest",
  config-info(title: [My Presentation]),
)

Pass a custom dictionary directly:

#let my-theme = (
  sea: rgb("#1f5d45"),
  sky: rgb("#a8d5ba"),
  skyl: rgb("#e9f5ee"),
  skyll: rgb("#f5fbf7"),
  paper: rgb("#f7faf8"),
  header-text: none,
  page-fill: white,
)

#show: xwysyy-pre.with(
  theme: my-theme,
  config-info(title: [My Presentation]),
)

Six fields are required; header-text is optional:

Field Purpose
sea Primary dark color for the header title, links, table heads, and badges
sky Accent color, also the fade-out end of the header rule
skyl Light background color
skyll Code block, table row, and textbox fill
paper Text on dark backgrounds
header-text Optional header title color override, none falls back to sea
page-fill Slide page background

Component Reference

Category API Usage
Slide entry xwysyy-pre #show: xwysyy-pre.with(theme: "sky", ...)
Dual-output entry xwysyy-doc default deck, --input mode=note for A4 notes
Title slide title-slide #title-slide()
Outline outline-slide #outline-slide() auto-collects section headings
Content slide xwysyy-slide == Title auto-triggers
Section transition new-section-slide = Title auto-triggers
Full-screen image image-slide #image-slide(img: image("bg.png"))
End slide end-slide #end-slide(title: [...])
Layout · pair duo-slide figure over text, measured spacing + telemetry
Layout · single focus-slide one centered block for sparse pages
Layout · columns grid-slide N equal-height peer columns
Layout · stack stack-slide N vertical blocks, the visual grows dominant or cards grow tall
Layout · compare compare-slide two top-aligned blocks read as a contrast
Layout · stats stat-slide a row of big-number metric tiles
Layout · figure figure-slide figure, tight caption, optional takeaway
Layout · sidebar sidebar-slide a label tab beside a content card
Text box textbox #textbox[Content] or #textbox([Col 1], [Col 2])
Highlight red / bred #red[text] / #bred[bold red]
Highlight yellow / byellow #yellow[text] / #byellow[bold yellow]
Note entry xwysyy-note #show: xwysyy-note.with(title: [...])
Extensions loader xwysyy-extras() lazily loads cetz, fletcher, and theorion integrations

Optional drawing and theorem integrations load only when xwysyy-extras() is called, so the core import keeps its smaller dependency set:

#import "@preview/xwysyy:0.4.0": *
#import xwysyy-extras(): *

The layout components (duo-slide, focus-slide, grid-slide, stack-slide, compare-slide, stat-slide, figure-slide, sidebar-slide) take typed content items (visual / card / takeaway / plain / metric) with declared sizing, measure every block, distribute space fill-first, and export <xwysyy-slide-layout> v4 telemetry (allocated frame, natural preferred size, 2-D payload bbox with a measured/declared source, and paint box + fill per object). For stepwise reveal use the components’ reveal: true parameter instead of #pause, which cannot appear inside the components (touying panics). See the layout guide.

Handouts And Speaker Notes

Pass touying’s handout setting through xwysyy-pre. A command-line switch can be wired as follows:

#let handout = sys.inputs.at("handout", default: "false") == "true"

#show: xwysyy-pre.with(
  config-common(handout: handout),
  config-info(title: [My Presentation]),
)

typst compile main.typ slides.pdf
typst compile --input handout=true main.typ slides-handout.pdf

Speaker notes are available because xwysyy.typ re-exports touying:

#speaker-note[
  Mention the ablation table before moving to the next section.
]

Export pdfpc metadata:

typst query main.typ --field value --one "<pdfpc-file>" > slides.pdfpc

One Source, Two Outputs

Use xwysyy-doc when one source should produce both deck and notes:

#import "@preview/xwysyy:0.4.0": *

#show: xwysyy-doc.with(
  title: [One Source, Two Outputs],
  subtitle: [Deck and A4 notes],
  theme: "forest",
)

Compile the deck:

typst compile main.typ slides.pdf

Compile the A4 notes:

typst compile --input mode=note main.typ notes.pdf

Requirements

  • Typst >= 0.14.0
  • touying 0.7.4, downloaded on first compile
  • physica 0.9.8, downloaded on first compile
  • Default local fonts: Times New Roman, Noto Serif CJK SC, Libertinus Sans, Noto Sans CJK SC, Maple Mono, and Noto Sans Mono CJK SC
  • Typst web app users can pass web-available fonts with font:, heading-font:, and code-font:

Full API reference: docs/USAGE.md. Customization guide: docs/CUSTOMIZATION.md. Theme generator: docs/THEME-GENERATOR.md.

Acknowledgements

License

MIT