mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-27 22:09:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add doc and a test for readDir

Browse Source 
Fixes #2009
This commit is contained in:
Bjørn Erik Pedersen
2016-03-31 23:16:42 +02:00
parent cb89ae63e9
commit c2277fcbc1
2 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/content/templates/functions.md
View File

@@ -337,6 +337,15 @@ e.g.
{{ end }}
## Files
### readDir
Gets a directory listing from a directory relative to the current project working dir.
So, If the project working dir has a single file named `README.txt`:
`{{ range (readDir ".") }}{{ .Name }}{{ end }}` → "README.txt"
### readFile
Reads a file from disk and converts it into a string. Note that the filename must be relative to the current project working dir.
So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`: