hugo-theme-relearn/exampleSite/content/configuration/sitemanagement/stableoutput/_index.en.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

+++
2024-10-12 17:28:28 +00:00
categories = ["howto"]
description = "How to make your generated HTML output stable"
options = ["disableAssetsBusting", "disableGeneratorVersion", "disableRandomIds"]
title = "Stable Output"
weight = 6
+++
## Disabling the Generator Meta
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The theme adds a meta tag with its version number to each page.
This isn't a security risk and helps us support you better.
To turn this off, set `disableGeneratorVersion=true`.
{{< multiconfig file=hugo >}}
[params]
disableGeneratorVersion = true
{{< /multiconfig >}}
If you also want to turn off [Hugo's version meta tag](https://gohugo.io/getting-started/configuration/#disablehugogeneratorinject), use `disableHugoGeneratorInject=true`.
## Disabling IDs for Referenced Assets
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The theme creates a unique ID for each build and adds it to each referenced asset's URL to make browsers not keep outdated cached assets.
This is good for production sites but can be problematic during development. It makes comparing outputs difficult as each build has new IDs.
To disable this, set `disableAssetsBusting=true`.
{{< multiconfig file=hugo >}}
[params]
disableAssetsBusting = true
{{< /multiconfig >}}
## Disabling IDs for Interactive HTML Elements
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Features like expanders, callouts, and tabs use unique IDs to work. These IDs change with each build.
This is necessary for the theme to work properly, but it can make comparing outputs between builds difficult.
To turn this off, set `disableRandomIds=true`. Note, that this will result in a non-functional site!.
{{< multiconfig file=hugo >}}
[params]
disableRandomIds = true
{{< /multiconfig >}}