hugoDocs/content/functions/readfile.md
Bud Parr 7fd64f19c8 Merge bp/theme-design branch containing Bud Parr's new design
It's a beautiful thing. A thousand thanks, Bud.

See PR rdwatters/hugo-docs-concept#118
2017-05-26 14:25:22 -05:00

874 B

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

readFile reads a file from disk and converts it into a string. Note that the filename must be relative to the current project working directory.

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!"

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