Typst Fumadocs

Read

Documentation for the `read` function.

Reads plain text or data from a file.

By default, the file will be read as UTF-8 and returned as a string.

If you specify encoding: none, this returns raw bytes instead.

Example

An example for a HTML file: #let text = read("example.html")#raw(text, block: true, lang: "html")Raw bytes:#read("tiger.jpg", encoding: none)
Preview
#read(
  path,
  encoding: none | str
) -> str bytes

Parameters

Prop

Type

On this page