aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/functions/go-template/template.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/go-template/template.md')
-rw-r--r--docs/content/en/functions/go-template/template.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/content/en/functions/go-template/template.md b/docs/content/en/functions/go-template/template.md
new file mode 100644
index 000000000..a78ec5c65
--- /dev/null
+++ b/docs/content/en/functions/go-template/template.md
@@ -0,0 +1,49 @@
+---
+title: template
+description: Executes the given template, optionally passing context.
+categories: []
+keywords: []
+action:
+ aliases: []
+ related:
+ - functions/go-template/define
+ - functions/partials/Include
+ - functions/partials/IncludeCached
+ returnType:
+ signatures: ['template NAME [CONTEXT]']
+---
+
+Use the `template` function to execute [internal templates]. For example:
+
+```go-html-template
+{{ range (.Paginate .Pages).Pages }}
+ <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+{{ end }}
+{{ template "_internal/pagination.html" . }}
+```
+
+You can also use the `template` function to execute a defined template:
+
+```go-html-template
+{{ template "foo" (dict "answer" 42) }}
+
+{{ define "foo" }}
+ {{ printf "The answer is %v." .answer }}
+{{ end }}
+```
+
+The example above can be rewritten using an [inline partial] template:
+
+```go-html-template
+{{ partial "inline/foo.html" (dict "answer" 42) }}
+
+{{ define "partials/inline/foo.html" }}
+ {{ printf "The answer is %v." .answer }}
+{{ end }}
+```
+
+{{% include "functions/go-template/_common/text-template.md" %}}
+
+[`partial`]: /functions/partials/include/
+[inline partial]: /templates/partials/#inline-partials
+[internal templates]: /templates/internal