From 7bf0d43ba879e001c014aafc9195e49bdaae7ba2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Tue, 22 Mar 2016 00:28:42 +0100 Subject: [PATCH] Add readFile template func This also includes a refactor of the hugofs package and its usage. The motivation for that is: The Afero filesystems are brilliant. Hugo's way of adding a dozen of global variables for the different filesystems was a mistake. In readFile (and also in some other places in Hugo today) we need a way to restrict the access inside the working dir. We could use ioutil.ReadFile and implement the path checking, checking the base path and the dots ("..") etc. But it is obviously better to use an Afero BasePathFs combined witha ReadOnlyFs. We could create a use-once-filesystem and handle the initialization ourselves, but since this is also useful to others and the initialization depends on some other global state (which would mean to create a new file system on every invocation), we might as well do it properly and encapsulate the predefined set of filesystems. This change also leads the way, if needed, to encapsulate the file systems in a struct, making it possible to have several file system sets in action at once (parallel multilanguage site building? With Moore's law and all...) Fixes #1551 --- content/templates/functions.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/content/templates/functions.md b/content/templates/functions.md index b271e33e1..fe0f2e251 100644 --- a/content/templates/functions.md +++ b/content/templates/functions.md @@ -83,7 +83,7 @@ e.g. Pass into "foo.html" a map with the keys "important, content" or create a map on the fly to pass into {{partial "foo" (dict "important" "Smiles" "content" "You should do more")}} - + ### slice @@ -336,6 +336,12 @@ e.g. {{ .Content }} {{ end }} +## Files +### 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!`: + + `{{readFile "README.txt"}}` → `"Hugo Rocks!"` ## Math