{"route":"/en-US-v0.13.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":"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,"deprecation":null,"details":"

Reads structured data from a YAML file.

\n

The file must contain a valid YAML object or array. YAML mappings will be\nconverted into Typst dictionaries, and YAML sequences will be converted into\nTypst arrays. Strings and booleans will be converted into the Typst\nequivalents, null-values (null, ~ or empty ``) will be converted into\nnone, and numbers will be converted to floats or integers depending on\nwhether they are whole numbers. Custom YAML tags are ignored, though the\nloaded value will still be present.

\n

Be aware that integers larger than 263-1 will be converted to\nfloating point numbers, which may give an approximative value.

\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\"
","example":null,"self":false,"params":[{"name":"source","details":"

A path to a YAML file or raw YAML bytes.

","example":null,"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,"deprecation":"`yaml.decode` is deprecated, directly pass bytes to `yaml` instead","details":"

Reads structured data from a YAML string/bytes.

","example":null,"self":false,"params":[{"name":"data","details":"

YAML data.

","example":null,"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,"deprecation":null,"details":"

Encode structured data into a YAML string.

","example":null,"self":false,"params":[{"name":"value","details":"

Value to be encoded.

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