yaml
Read structured data from a YAML file.
The file must contain a valid YAML object or array. YAML mappings will be
converted into Typst dictionaries, and YAML sequences will be converted into
Typst arrays. Strings and booleans will be converted into the Typst
equivalents, null-values (null
, ~
or empty ``) will be converted into
none
, and numbers will be converted to floats or integers depending on
whether they are whole numbers.
Note that mapping keys that are not a string cause the entry to be discarded.
Custom YAML tags are ignored, though the loaded value will still be present.
The function returns a dictionary or value or an array, depending on the YAML file.
The YAML files in the example contain objects with authors as keys, each with a sequence of their own submapping with the keys "title" and "published"
Example
#let bookshelf(contents) = {
for (author, works) in contents {
author
for work in works [
- #work.title (#work.published)
]
}
}
#bookshelf(
yaml("scifi-authors.yaml")
)

ParametersParameters are the inputs to a function. They are specified in parentheses after the function name.
path
Path to a YAML file.