summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/getenv.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/getenv.md')
-rw-r--r--docs/content/en/functions/getenv.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/content/en/functions/getenv.md b/docs/content/en/functions/getenv.md
new file mode 100644
index 000000000..8153cc07c
--- /dev/null
+++ b/docs/content/en/functions/getenv.md
@@ -0,0 +1,31 @@
+---
+title: getenv
+description: Returns the value of an environment variable.
+godocref:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-02-01
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+keywords: []
+signature: ["getenv VARIABLE"]
+workson: []
+hugoversion:
+relatedfuncs: []
+deprecated: false
+aliases: []
+---
+
+Takes a string containing the name of the variable as input. Returns
+an empty string if the variable is not set, otherwise returns the
+value of the variable.
+
+```
+{{ getenv "HOME" }}
+```
+
+{{% note %}}
+In Unix-like environments, the variable must also be exported in order to be seen by `hugo`.
+{{% /note %}}