Files
hugo/docs/content/en/functions/readfile.md
2021-12-08 08:54:25 +01:00

1.1 KiB

title, description, date, publishdate, lastmod, categories, menu, keywords, signature, workson, hugoversion, relatedfuncs, deprecated, aliases
title description date publishdate lastmod categories menu keywords signature workson hugoversion relatedfuncs deprecated aliases
readFile Returns the contents of a file. 2017-02-01 2017-02-01 2021-11-26
functions
docs
parent
functions
files
os.ReadFile PATH
readFile PATH
os.FileExists
os.ReadDir
os.Stat
false

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]({{< relref "getting-started/configuration#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]({{< relref "/templates/files" >}}).