2c0d1ccdcd
73f355ce Update theme 83ff50c2 Use example.com in examples 71292134 Add alias news > release-notes 2e15f642 Update theme 8eef09d2 Add Pygments configuration 572b9e75 Clean up the code shortcode use a1b2fd3b Remove the code fence language codes 1473b1d9 Remove redundant text b92c2042 Update theme 8f439c28 Edit contributing section in README 8bcf8a19 Add contributing section to README 4c44ee1c Fix broken content file 2bdc7710 Clarify .Data.Pages sorting in lists.md 092271c2 Use infinitive mood for main titles b9b8abef Update theme to reflect change to home page content b897b71b Change copy to use sentence case fd675ee5 Enable RSS feed for sections 060a5e27 Correct movie title in taxonomies.md 6a5ca96a Update displayed site name for Hub 22f4b7a4 Add example of starting up the local server d9612cb3 Update theme a8c3988a Update theme 4198189d Update theme 12d6b016 Update theme 2b1c4197 Update theme b6d90a1e Fix News release titles cfe751db Add some build info to README git-subtree-dir: docs git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d
2.2 KiB
| title | description | godocref | date | publishdate | lastmod | categories | menu | weight | sections_weight | draft | aliases | toc | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Template Debugging | 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. | http://golang.org/pkg/fmt/ | 2017-02-01 | 2017-02-01 | 2017-02-01 |
|
|
180 | 180 | false | 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.
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.
{{ printf "%#v" $.Site }}
This will print out the value of .Permalink:
{{ printf "%#v" .Permalink }}
This will print out a list of all the variables scoped to the current context
(., aka "the dot").
{{ printf "%#v" . }}
When developing a homepage, what does one of the pages you're looping through look like?
{{ range .Data.Pages }}
{{/* The context, ".", is now each one of the pages as it goes through the loop */}}
{{ printf "%#v" . }}
{{ end }}
{{% note ".Data.Pages on the Homepage" %}}
.Data.Pages on the homepage is equivalent to .Site.Pages.
{{% /note %}}
Why Am I Showing No Defined Variables?
Check that you are passing variables in the partial function:
{{ partial "header" }}
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".
{{ partial "header" . }}
The dot (.) is considered fundamental to understanding Hugo templating. For more information, see Introduction to Hugo Templating.