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/baseof.html

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

layouts/page.html

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

layouts/section.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: August 17, 2025 : content: Adjust Markdown to pass linter tests (b17999021)

Improve this page