TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-13 03:17:33 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated readFile documentation

Browse Source 
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.
This commit is contained in:
Lucas Westermann 2018-04-16 10:07:54 +02:00 committed by Bjørn Erik Pedersen
parent 8fd130395f
commit 87c539101d
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/functions/readfile.md
View File

@ -18,7 +18,7 @@ deprecated: false
aliases: []
---
Note that the filename must be relative to the current project working directory.
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!`:
@ -26,6 +26,8 @@ So, if you have a file with the name `README.txt` in the root of your project wi
{{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][local].
[local]: /templates/files/