mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
41bc6f702a
2c0125b52 Remove .Site.Author 2cf8841b3 Update partialCached.md (#1924) 385487191 Update data-templates.md (#1926) ce207e141 Remove redundant markdown and fix a few typos (#1936) 3687c2953 Make heading id linkable, take 2 45c79bea7 Make heading id linkable b22079344 Delete duplicates the lines 557-569 and 570-582. (#1934) 0a90dc122 Rework the taxonomy variables page (#1935) 7f8979c50 Update theme 26e682a3a Update multilingual.md d40e7693f Update postcss.md 375d75c01 Update postcss npm instructions (#1931) 63020094a Emphasize Window shell selection (#1930) 56824be2c Update configuration.md b7b8f16b3 Docu 'Theme components': minor fix (#1929) 09dc81a05 Remove Docker from BSD page (#1927) 205fea204 netlify: Hugo 0.108.0 6abe49c28 Merge commit 'da670c38ee63a7fef25e2b9f42519232055b60dc' 12b59a4c5 docs: Add basic doc for wrapStandAloneImageWithinParagraph etc. ba07bd970 dartsass: Add sourceMapIncludeSources option git-subtree-dir: docs git-subtree-split: 2c0125b5290494d49334606c451446ebd9df3c21
69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
---
|
|
title: Template Debugging
|
|
description: You can use Go templates' `printf` function to debug your Hugo templates. These snippets provide a quick and easy visualization of the variables available to you in different contexts.
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
categories: [templates]
|
|
keywords: [debugging,troubleshooting]
|
|
menu:
|
|
docs:
|
|
parent: "templates"
|
|
weight: 180
|
|
weight: 180
|
|
sections_weight: 180
|
|
aliases: []
|
|
toc: false
|
|
---
|
|
|
|
Here are some snippets you can add to your template to answer some common questions.
|
|
|
|
These snippets use the `printf` function available in all Go templates. This function is an alias to the Go function, [fmt.Printf](https://pkg.go.dev/fmt).
|
|
|
|
## What Variables are Available in this Context?
|
|
|
|
You can use the template syntax, `$.`, to get the top-level template context from anywhere in your template. This will print out all the values under, `.Site`.
|
|
|
|
```go-html-template
|
|
{{ printf "%#v" $.Site }}
|
|
```
|
|
|
|
This will print out the value of `.Permalink`:
|
|
|
|
```go-html-template
|
|
{{ printf "%#v" .Permalink }}
|
|
```
|
|
|
|
This will print out a list of all the variables scoped to the current context
|
|
(`.`, aka ["the dot"][tempintro]).
|
|
|
|
```go-html-template
|
|
{{ printf "%#v" . }}
|
|
```
|
|
|
|
When developing a [homepage], what does one of the pages you're looping through look like?
|
|
|
|
```go-html-template
|
|
{{ range .Pages }}
|
|
{{/* The context, ".", is now each one of the pages as it goes through the loop */}}
|
|
{{ printf "%#v" . }}
|
|
{{ end }}
|
|
```
|
|
|
|
## Why Am I Showing No Defined Variables?
|
|
|
|
Check that you are passing variables in the `partial` function:
|
|
|
|
```go-html-template
|
|
{{ partial "header.html" }}
|
|
```
|
|
|
|
This example will render the header partial, but the header partial will not have access to any contextual variables. You need to pass variables explicitly. For example, note the addition of ["the dot"][tempintro].
|
|
|
|
```go-html-template
|
|
{{ partial "header.html" . }}
|
|
```
|
|
|
|
The dot (`.`) is considered fundamental to understanding Hugo templating. For more information, see [Introduction to Hugo Templating][tempintro].
|
|
|
|
[homepage]: /templates/homepage/
|
|
[tempintro]: /templates/introduction/
|