The Ambrosia Guide / 0.1.0 PDF Manual ↗
API Index
Browse by object rather than following the introductory guides. Each group
links to usage, options, and editable examples. Prefer prefixed names with a
wildcard import, or the scoped ambrosia API when combining libraries.
Slides
These helpers keep the same names inside ambrosia, such as
ambrosia.title-slide() and ambrosia.slide(...).
| Helper | Purpose | Guide |
|---|---|---|
slide | Ordinary content; two positional bodies create columns. | Composition |
title-slide | Opening metadata and logos. | Title Layouts |
outline-slide | Fitted presentation overview. | Agendas |
new-section-slide | Current-section agenda; automatic transition by default. | Agendas |
section-slide | Simple counted divider. | Slide Helpers |
focus-slide | Central message with frozen slide counter. | Slide Helpers |
image-slide | Full-page image and caption/credit placement. | Image Slides |
bibliography-slide | Visible reference list. | Citations |
ending-slide | Closing content, contacts, and marks. | Ending Layouts |
backup-slide | Interlude with frozen slide counter. | Slide Helpers |
appendix | Show rule starting a separately numbered appendix. | Appendix Numbers |
The theme’s agenda-style and agenda-text-size apply to both outline-slide
and automatic section dividers; each helper accepts local style: and
text-size: overrides.
Components
| Global names | Scoped equivalents | Guide |
|---|---|---|
ambrosia-block | ambrosia.block | Block Styles And Kinds |
ambrosia-badge, ambrosia-source-note | ambrosia.badge, ambrosia.source-note | Text And Annotations |
alert, muted, subtle | Same names inside ambrosia | Text And Annotations |
ambrosia-shadow | ambrosia.shadow | Shadows |
footcite, hidden-bibliography | Same names inside ambrosia | Citations |
ambrosia-affiliation | ambrosia.affiliation | Linked Affiliations |
ambrosia-roadmap | ambrosia.roadmap | Roadmaps |
ambrosia-palette-showcase | ambrosia.palette-showcase | Palettes |
ambrosia-slide-preview | ambrosia.slide-preview | Linked Slide Previews |
ambrosia-navigation-buttons | ambrosia.navigation-buttons | Transparent Buttons |
ambrosia-credit-card | ambrosia.credit-card | Theme Credits |
Configuration And Descriptors
| Global names | Scoped equivalents | Guide |
|---|---|---|
ambrosia-theme | ambrosia.theme | Configuration Layers |
config-info | ambrosia.config-info | Authors And Institutions |
ambrosia-flavor | ambrosia.flavor | Flavors |
ambrosia-palette | ambrosia.palette | Palettes |
ambrosia-navigation | ambrosia.navigation | Navigation |
ambrosia-title-layout | ambrosia.title-layout | Title Layouts |
ambrosia-ending-layout | ambrosia.ending-layout | Ending Layouts |
config-common, config-store, config-page, config-colors | Same names inside ambrosia | Configuration Layers |
Touying configuration and animation helpers are re-exported. Start with
content and reveals for pause
and the Touying documentation for their full API.
Its re-exported speaker-note (ambrosia.speaker-note) is covered separately
in Extras: Presenter Notes With Touying.
Imports
The scoped import is convenient when combining packages:
#import "@preview/touying-ambrosia:0.1.0": ambrosia-theme, ambrosia
#show: ambrosia-theme.with(
flavor: "minimal", palette: "ocean",
ambrosia.config-info(title: [Research], author: [Presenter]),
)
#ambrosia.title-slide()
#ambrosia.slide(title: [A Result])[
#ambrosia.block(style: "poster", kind: "success", title: [Result])[Evidence.]
]
A wildcard import remains available. If importing Touying directly too, import Ambrosia after it to select Ambrosia’s presentation overrides.
Institution wrappers use the supported extensions module and
ambrosia-flavor builder; see Create Your Own Theme.
Other internal source paths are implementation details.