summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/readdir.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/readdir.md')
-rw-r--r--docs/content/en/functions/readdir.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/content/en/functions/readdir.md b/docs/content/en/functions/readdir.md
new file mode 100644
index 000000000..21f626692
--- /dev/null
+++ b/docs/content/en/functions/readdir.md
@@ -0,0 +1,30 @@
+---
+title: readDir
+description: Gets a directory listing from a directory relative to the current working directory.
+godocref:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-02-01
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+keywords: [files]
+signature: ["readDir PATH"]
+workson: []
+hugoversion:
+relatedfuncs: [readFile]
+deprecated: false
+aliases: []
+---
+
+If your current project working directory has a single file named `README.txt`:
+
+```
+{{ range (readDir ".") }}{{ .Name }}{{ end }} → "README.txt"
+```
+
+For more information on using `readDir` and `readFile` in your templates, see [Local File Templates][local].
+
+[local]: /templates/files/
+