{"route":"/en-US-v0.14.1/reference/data-loading/read/","title":"Read","description":"Documentation for the `read` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-path","name":"path","children":[]},{"id":"parameters-encoding","name":"encoding","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"read","title":"Read","keywords":[],"oneliner":"Reads plain text or data from a file.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Reads plain text or data from a file.

\n

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

\n

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

\n

Example

\n
An example for a HTML file: \\\n#let text = read("example.html")\n#raw(text, lang: "html")\n\nRaw bytes:\n#read("tiger.jpg", encoding: none)\n
\"Preview\"
"}],"self":false,"params":[{"name":"path","details":[{"kind":"html","content":"

Path to a file.

\n

For more details, see the Paths section.

"}],"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"encoding","details":[{"kind":"html","content":"

The encoding to read the file with.

\n

If set to none, this function returns raw bytes.

"}],"types":["none","str"],"strings":[{"string":"utf8","details":"

The Unicode UTF-8 encoding.

"}],"default":""utf8"","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str","bytes"],"scope":[]}}}