block

Defines a template and executes it in place.

Syntax

block NAME CONTEXT

A block is shorthand for defining a template:

{{ define "name" }} T1 {{ end }}

and then executing it in place:

{{ template "name" pipeline }}

The typical use is to define a set of root templates that are then customized by redefining the block templates within.

layouts/_default/baseof.html

<body>
  <main>
    {{ block "main" . }}
      {{ print "default value if 'main' template is empty" }}
    {{ end }}
  </main>
</body>

layouts/_default/single.html

{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
{{ end }}

layouts/_default/list.html

{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
  {{ range .Pages }}
    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ end }}
{{ end }}

See Go’s text/template documentation for more information.

Last updated: December 4, 2023 : Squashed 'docs/' changes from 4d936aee6..4dd2d6415 (35dec7c96)

Improve this page