HUGO
Menu
GitHub 90048 stars Mastodon

os.ReadFile

Returns the contents of a file.
Syntax
os.ReadFile PATH
Returns
string
Alias
readFile

The os.ReadFile function attempts to resolve the path relative to the root of your project directory, then relative to the root of each module. If a matching file is not found, it will attempt to resolve the path relative to the content directory of the unified file system. 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:

{{ readFile "README.md" }}

Produces:

This is **bold** text.

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