hugo/docs/content/en/functions/os/ReadFile.md
2023-10-20 09:43:56 +02:00

1.1 KiB

title linkTitle description categories keywords menu function relatedFunctions aliases
os.ReadFile readFile Returns the contents of a file.
functions
docs
parent
functions
aliases returnType signatures
readFile
string
os.ReadFile PATH
os.FileExists
os.Getenv
os.ReadDir
os.ReadFile
os.Stat
/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:

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