mirror
/
hugo
mirror of https://github.com/gohugoio/hugo
1
0
Fork 0
Code Issues
hugo/docs/content/en/templates/base.md

3.1 KiB
Raw Permalink Blame History

title description categories keywords menu weight toc aliases
Base templates The base and block construct allows you to define the outer shell of your master templates (i.e., the chrome of the page).
templates
fundamentals
docs
parent weight
templates 50
50 true
/templates/blocks/
/templates/base-templates-and-blocks/

The block keyword allows you to define the outer shell of your pages' one or more master template(s) and then fill in or override portions as necessary.

{{< youtube QVOMCYitLEc >}}

Base template lookup order

The base template lookup order closely follows that of the template it applies to (e.g. _default/list.html).

See Template Lookup Order for details and examples.

Define the base template

The following defines a simple base template at _default/baseof.html. As a default template, it is the shell from which all your pages will be rendered unless you specify another *baseof.html closer to the beginning of the lookup order.

{{< code file=layouts/_default/baseof.html >}}

<html> <head> </head> {{ block "main" . }} {{ end }} {{ block "footer" . }} {{ end }} </html> {{< /code >}}

Override the base template

The default list template will inherit all of the code defined above and can then implement its own "main" block from:

{{< code file=layouts/_default/list.html >}} {{ define "main" }}

Posts

{{ range .Pages }}

{{ .Title }}

{{ .Content }}
{{ end }} {{ end }} {{< /code >}}

This replaces the contents of our (basically empty) "main" block with something useful for the list template. In this case, we didn't define a "title" block, so the contents from our base template remain unchanged in lists.

{{% note %}} Code that you put outside the block definitions can break your layout. This even includes HTML comments. For example:

<!-- Seemingly harmless HTML comment..that will break your layout at build -->
{{ define "main" }}
...your code here
{{ end }}

See this thread from the Hugo discussion forums. {{% /note %}}

The following shows how you can override both the "main" and "title" block areas from the base template with code unique to your default single template:

{{< code file=layouts/_default/single.html >}} {{ define "title" }}

{{ .Title }} – {{ .Site.Title }} {{ end }} {{ define "main" }}

{{ .Title }}

{{ .Content }} {{ end }} {{< /code >}}