Hugo RawContent and Content Fingerprints⁠🆔
Updated  by  nm  2022-June-13

Page contents

News

2023-August-17  As of today, this evolving⁠[1] article has been on the web for 2 years.🕯🕯

Prerequisites

This article assumes you know the basics about the Hugo static site generator.

 

Anatomy of a Hugo page’s primary source file

Abstractly a Hugo page’s primary⁠[2] source file looks like this:

front matter

main matter
 

Details about this are in Infinite Ink’s Hugo Tutorial in the section Anatomy of a content file.

 

Using a page’s main matter in a Hugo layout file

In a Hugo layout file, the main matter of a page can be accessed with the following page variables.

.RawContent

The main matter as it appears in the source file, i.e., everything below the front matter.

.Content

The main matter after it has been processed by Hugo with the help of markup renderers, such as Asciidoctor, go-org, Goldmark, or Pandoc.

 

Fingerprinting or hashing a page

One way to check if a page has changed is to check its fingerprint or hash. For example, a hash of this page’s RawContent is:

2331E9

The Hugo shortcode that produced the above hash includes one of the following lines.

{{ .Page.RawContent | sha256 | truncate 6 "" | upper }}
{{ substr (.Page.RawContent | sha256 | upper) 0 6 }}
{{ slicestr (.Page.RawContent | sha256 | upper) 0 6 }}

Each of the above three lines produces this:

2331E9

 

If a page does not use any external snippets,⁠[3] it’s often sufficient to use the above .Page.RawContent fingerprint. But if a page uses external snippets, you need to fingerprint .Page.Content with, for example, this:

{{ .Page.Content | sha256 | truncate 6 "" | upper }}

 

Fingerprinting the Content, rather than the RawContent, is needed because it’s possible that the RawContent is unchanged but an external snippet has changed.

A hash of the Content of this page is in the Page Meta section below.

References

 

See also

For more about Hugo, see Infinite Ink’s


 

Endnotes

1. Many Infinite Ink pages, including this one, are evergreen đŸŒČ and regularly updated.
2. It is possible for a Hugo page’s primary source file to pull snippets from other (non-primary) source files.
3. Snippets can be specified in front matter, Hugo layout files (including Hugo shortcodes), AsciiDoc attributes, and AsciiDoc includes.

Please share & discuss 📝 👎 👍 📯