readFile

Syntax

os.ReadFile PATH

readFile PATH

The os.ReadFile function attempts to resolve the path relative to the root of your project directory. If a matching file is not found, it will attempt to resolve the path relative to the contentDir. A leading path separator (/) is optional.

With a file named README.md in the root of your project directory:

This is **bold** text.

This template code:

{{ os.ReadFile "README.md" }}

Produces:

This is **bold** text.

Note that os.ReadFile returns raw (uninterpreted) content.

For more information on using readDir and readFile in your templates, see Local File Templates.