From d67b6d82e4a1f3a8332eb378ee840a4245d53534 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Fri, 21 Jun 2024 15:21:07 +0200 Subject: [PATCH] Update content/en/functions/templates/Defer.md Co-authored-by: Joe Mooring --- content/en/functions/templates/Defer.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/content/en/functions/templates/Defer.md b/content/en/functions/templates/Defer.md index ae71f7345..eb69b86ee 100644 --- a/content/en/functions/templates/Defer.md +++ b/content/en/functions/templates/Defer.md @@ -14,14 +14,10 @@ aliases: [/functions/templates.defer] {{< new-in "0.128.0" >}} -{{% note %}} -This function only works in combination with the `with` keyword. -{{% /note %}} - -In some rare use cases, you may need defer the execution of a template until after all sites and output formats have been rendered. One such example could be [TailwindCSS](https://github.com/bep/hugo-starter-tailwind-basic) using the output of [hugo_stats.json](https://gohugo.io/getting-started/configuration/#configure-build) to determine which classes and other HTML identifiers are being used in the final output: +In some rare use cases, you may need to defer the execution of a template until after all sites and output formats have been rendered. One such example could be [TailwindCSS](https://github.com/bep/hugo-starter-tailwind-basic) using the output of [hugo_stats.json](https://gohugo.io/getting-started/configuration/#configure-build) to determine which classes and other HTML identifiers are being used in the final output: ```go-html-template -{{ with (templates.Defer (dict "key" "styles" )) }} +{{ with (templates.Defer (dict "key" "global-styles" )) }} {{ $options := dict "inlineImports" true }} {{ $styles := resources.Get "css/styles.css" }} {{ $styles = $styles | resources.PostCSS $options }} @@ -32,9 +28,13 @@ In some rare use cases, you may need defer the execution of a template until aft {{ end }} ``` +{{% note %}} +This function only works in combination with the `with` keyword. +{{% /note %}} + {{% note %}} -Variables defined on the outside are not visible on the inside and vice versa. +Variables defined on the outside are not visible on the inside and vice versa. To pass in data, use the `data` [option](#options). {{% /note %}} For the above to work well when running the server (or `hugo -w`), you want to have a configuration similar to this: @@ -46,7 +46,7 @@ source = "hugo_stats.json" target = "assets/notwatching/hugo_stats.json" disableWatch = true [build.buildStats] -writeStats = true +enable = true [[build.cachebusters]] source = "assets/notwatching/hugo_stats\\.json" target = "styles\\.css" @@ -69,13 +69,13 @@ data (`map`) ```go-html-template Language Outside: {{ site.Language.Lang }} Page Outside: {{ .RelPermalink }} -I18n: {{ i18n "hello" }} +I18n Outside: {{ i18n "hello" }} {{ $data := (dict "page" . )}} {{ with (templates.Defer (dict "data" $data )) }} Language Inside: {{ site.Language.Lang }} Page Inside: {{ .page.RelPermalink }} - I18n: {{ i18n "hello" }} + I18n Inside: {{ i18n "hello" }} {{ end }} ``` -The [Output Format](/templates/output-formats/), [Site](/methods/page/site/), and [language](/methods/site/language) will be the same, even if the execution is deferred. In the example above, this means that the `site.Language.Lang` and `.RelPermalink` will be the same inside and outside the deferred template. +The [Output Format](/templates/output-formats/), [Site](/methods/page/site/), and [language](/methods/site/language) will be the same, even if the execution is deferred. In the example above, this means that the `site.Language.Lang` and `.RelPermalink` will be the same on the inside and the outside the deferred template.