hugo/docs/content/en/functions/readfile.md
2023-05-22 16:47:07 +02:00

953 B

title description categories menu keywords signature relatedfuncs
readFile Returns the contents of a file.
functions
docs
parent
functions
files
os.ReadFile PATH
readFile PATH
os.FileExists
os.ReadDir
os.Stat

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.