{"route":"/en-US-v0.14.1/reference/data-loading/yaml/","title":"YAML","description":"Documentation for the `yaml` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"conversion","name":"Conversion","children":[{"id":"notes","name":"Notes","children":[]}]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-source","name":"source","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-decode","name":"Decode YAML","children":[{"id":"definitions-decode-data","name":"data","children":[]}]},{"id":"definitions-encode","name":"Encode YAML","children":[{"id":"definitions-encode-value","name":"value","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"yaml","title":"YAML","keywords":[],"oneliner":"Reads structured data from a YAML file.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Reads structured data from a YAML file.

\n

The file must contain a valid YAML object or array. The YAML values will be\nconverted into corresponding Typst values as listed in the\ntable below.

\n

The function returns a dictionary, an array or, depending on the YAML file,\nanother YAML data type.

\n

The YAML files in the example contain objects with authors as keys,\neach with a sequence of their own submapping with the keys\n"title" and "published".

\n

Example

\n
#let bookshelf(contents) = {\n  for (author, works) in contents {\n    author\n    for work in works [\n      - #work.title (#work.published)\n    ]\n  }\n}\n\n#bookshelf(\n  yaml("scifi-authors.yaml")\n)\n
\"Preview\"
\n

Conversion details

\n\n\n\n\n\n\n\n
YAML valueConverted into Typst
null-values (null, ~ or empty )none
booleanbool
numberfloat or int
stringstr
sequencearray
mappingdictionary
\n\n\n\n\n\n\n
Typst valueConverted into YAML
types that can be converted from YAMLcorresponding YAML value
bytesstring via repr
symbolstring
contenta mapping describing the content
other types (length, etc.)string via repr
\n

Notes

\n"}],"self":false,"params":[{"name":"source","details":[{"kind":"html","content":"

A path to a YAML file or raw YAML bytes.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[{"path":["yaml"],"name":"decode","title":"Decode YAML","keywords":[],"oneliner":"Reads structured data from a YAML string/bytes.","element":false,"contextual":false,"deprecationMessage":"`yaml.decode` is deprecated, directly pass bytes to `yaml` instead","deprecationUntil":"0.15.0","details":[{"kind":"html","content":"

Reads structured data from a YAML string/bytes.

"}],"self":false,"params":[{"name":"data","details":[{"kind":"html","content":"

YAML data.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["yaml"],"name":"encode","title":"Encode YAML","keywords":[],"oneliner":"Encode structured data into a YAML string.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Encode structured data into a YAML string.

"}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

Value to be encoded.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["str"],"scope":[]}]}}}