summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDave Henderson <dhenderson@gmail.com>2022-04-09 16:36:58 -0400
committerDave Henderson <dhenderson@gmail.com>2022-04-10 15:27:15 -0400
commitae1620810cbd82eadd71abb51ba2fea97cf50a59 (patch)
treea907ef15a3959cf1ac7101ea1bc5becc038b6605 /docs
parent6c66d16b7ccb32636688c644b670141b5e5341aa (diff)
New tmpl.Path/tmpl.PathDir functions
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/content/functions/tmpl.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/content/functions/tmpl.md b/docs/content/functions/tmpl.md
index 527fa2b6..d7ce870e 100644
--- a/docs/content/functions/tmpl.md
+++ b/docs/content/functions/tmpl.md
@@ -80,3 +80,58 @@ $ gomplate -i '
hello world
goodbye world
```
+
+## `tmpl.Path`
+
+Output the path of the current template, if it came from a file. For
+inline templates, this will be an empty string.
+
+Note that if this function is called from a nested template, the path
+of the main template will be returned instead.
+
+### Usage
+
+```go
+tmpl.Path
+```
+
+
+### Examples
+
+_`subdir/input.tpl`:_
+```
+this template is in {{ tmpl.Path }}
+```
+
+```console
+$ gomplate -f subdir/input.tpl
+this template is in subdir/input.tpl
+```
+```
+
+## `tmpl.PathDir`
+
+Output the current template's directory. For inline templates, this will
+be an empty string.
+
+Note that if this function is called from a nested template, the path
+of the main template will be used instead.
+
+### Usage
+
+```go
+tmpl.PathDir
+```
+
+
+### Examples
+
+_`subdir/input.tpl`:_
+```
+this template is in {{ tmpl.Dir }}
+```
+
+```console
+$ gomplate -f subdir/input.tpl
+this template is in subdir
+```