mirror of
https://github.com/gohugoio/hugo.git
synced 2026-09-02 11:42:37 +00:00
Lucas Westermann
87c539101d
I've re-written the opening sentence to reflect the fact that the function checks multiple locations. I also added in a separate paragraph at the end to indicate that paths in error messages should be taken with a grain of salt.
1.0 KiB
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 |
|
|
|
|
|
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.