github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages 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
Show stats 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 }} {{ end }}
## Files ## 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 ### 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. 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!`: So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`:

2
tpl/template_funcs_test.go
View file

@ -121,6 +121,7 @@ safeURL: {{ "http://gohugo.io" | safeURL | safeURL }}
safeJS: {{ "(1*2)" | safeJS | safeJS }} safeJS: {{ "(1*2)" | safeJS | safeJS }}
plainify: {{ plainify "Hello <strong>world</strong>, gophers!" }} plainify: {{ plainify "Hello <strong>world</strong>, gophers!" }}
readFile: {{ readFile "README.txt" }} readFile: {{ readFile "README.txt" }}
readDir: {{ range (readDir ".") }}{{ .Name }}{{ end }}
` `
expected := `chomp: <p>Blockhead</p> expected := `chomp: <p>Blockhead</p>
dateFormat: Wednesday, Jan 21, 2015 dateFormat: Wednesday, Jan 21, 2015
@ -166,6 +167,7 @@ safeURL: http://gohugo.io
safeJS: (1*2) safeJS: (1*2)
plainify: Hello world, gophers! plainify: Hello world, gophers!
readFile: Hugo Rocks! readFile: Hugo Rocks!
readDir: README.txt
` `
var b bytes.Buffer var b bytes.Buffer