hugo/docs/content/en/functions/os/ReadFile.md
2023-12-04 15:24:01 +01:00

1 KiB

title description categories keywords action aliases
os.ReadFile Returns the contents of a file.
aliases related returnType signatures
readFile
functions/os/FileExists
functions/os/Getenv
functions/os/ReadDir
functions/os/Stat
string
os.ReadFile PATH
/functions/readfile

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:

{{ 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.