1
0
mirror of https://github.com/gohugoio/hugo.git synced 2024-05-11 05:54:58 +00:00
Files
gohugoio-hugo/docs/content/en/functions/readfile.md
2018-05-04 09:44:59 +02:00

1.0 KiB

title, description, godocref, date, publishdate, lastmod, categories, menu, keywords, signature, workson, hugoversion, relatedfuncs, deprecated, aliases
title description godocref date publishdate lastmod categories menu keywords signature workson hugoversion relatedfuncs deprecated aliases
readFile Reads a file from disk relative to the current project working directory and returns a string. 2017-02-01 2017-02-01 2017-04-30
functions
docs
parent
functions
files
readFile PATH
readDir
false

Note that the filename must be relative to the current project working directory, or the project's /content folder.

So, if you have a file with the name README.txt in the root of your project with the content Hugo Rocks!:

{{readFile "README.txt"}} → "Hugo Rocks!"

If you receive a "file doesn't exist" error with a path listed, do take note that the path is the last one checked by the function, and may not accurately reflect your target. You should generally double-check your path for mistakes.

For more information on using readDir and readFile in your templates, see Local File Templates.