The page you requested cannot be found.
{{ end }} For multilingual projects, add the language key to the file name: layouts/ ├── 404.de.html ├── 404.en.html └── 404.fr.html Your production server redirects the browser to the 404 page when a page is not found. Capabilities and configuration vary by host. | Host | Capabilities and configuration | | --- | --- | | Amazon CloudFront | See [details](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GeneratingCustomErrorResponses.html){{ debug.Dump $taxonomyObject }}
Although the [`Alphabetical`](https://gohugo.io/methods/taxonomy/alphabetical/)
and [`ByCount`](https://gohugo.io/methods/taxonomy/bycount/)
methods provide a better data structure for ranging through the taxonomy, you can render the weighted pages by term directly from the `Taxonomy` object:
{{ range $term, $weightedPages := $taxonomyObject }}
{{ debug.Dump $taxonomyObject.Alphabetical }}
An ordered taxonomy is a slice, where each element is an object that contains the term and a slice of its weighted pages.
Each element of the slice provides these methods:
Count
(`int`) Returns the number of pages to which the term is assigned.
Page
(`page.Page`) Returns the term’s `Page` object, useful for linking to the term page.
Pages
(`page.Pages`) Returns a `Pages` object containing the `Page` objects to which the term is assigned, sorted by [taxonomic weight](https://gohugo.io/quick-reference/glossary/#taxonomic-weight)
. To sort or group, use any of the [methods](https://gohugo.io/methods/pages/)
available to the `Pages` object. For example, sort by the last modification date.
Term
(`string`) Returns the term name.
WeightedPages
(`page.WeightedPages`) Returns a slice of weighted pages to which the term is assigned, sorted by taxonomic weight. The `Pages` method above is more flexible, allowing you to sort and group.
Example
-------
With this template:
{{ range $taxonomyObject.Alphabetical }}
Everything in this block will be wrapped.
{{ .Content | transform.Plainify | strings.Truncate 200 }}
{{ end }} Inside the partial template, place the `templates.Inner` function call where the wrapped content should appear. layouts/\_partials/components/wrapper.html{{ .page.Content | plainify | strings.Truncate 240 }}
{{ end }} {{ end }} {{ end }}Copyright {{ now.Year }}. All rights reserved.
Execute the _partial_ template by calling the [`partial`](https://gohugo.io/functions/partials/include/) or [`partialCached`](https://gohugo.io/functions/partials/includecached/) function, optionally passing context as the second argument: layouts/baseof.html {{ partial "footer.html" . }} Unlike other template types, Hugo does not consider the current page kind, content type, logical path, language, or output format when searching for a matching _partial_ template. However, it _does_ apply the same _name_ matching logic it uses for other template types. This means it tries to find the most specific match first, then progressively looks for more general versions if the specific one isn’t found. For example, with this call: layouts/baseof.html {{ partial "footer.section.de.html" . }} Hugo uses this lookup order to find a matching template: 1. `layouts/_partials/footer.section.de.html` 2. `layouts/_partials/footer.section.html` 3. `layouts/_partials/footer.de.html` 4. `layouts/_partials/footer.html` A _partial_ template can also be defined inline within another template. However, it’s important to note that the template namespace is global; ensuring unique names for these _partial_ templates is necessary to prevent conflicts. Value: {{ partial "my-inline-partial.html" . }} {{ define "_partials/my-inline-partial.html" }} {{ $value := 32 }} {{ return $value }} {{ end }} Content view ------------ A _content view_ template is similar to a _partial_ template, invoked by calling the [`Render`](https://gohugo.io/methods/page/render/) method on a `Page` object. Unlike _partial_ templates, _content view_ templates: * Inherit the context of the current page * Can target any page kind, content type, logical path, language, or output format * Can reside at any level within the `layouts` directory For example, Hugo applies a _base_ template to the _home_ template below, then renders the page content and a card component for each page within the “films” section of your site. layouts/home.html {{ define "main" }} {{ .Content }}The product of {{ $v1 }} and {{ $v2 }} is {{ mul $v1 $v2 }}.
While HTML templates are the most common, you can create templates for any [output format](https://gohugo.io/quick-reference/glossary/#output-format) including CSV, JSON, RSS, and plain text. Context ------- The most important concept to understand before creating a template is _context_, the data passed into each template. The data may be a simple value, or more commonly [objects](https://gohugo.io/quick-reference/glossary/#object) and associated [methods](https://gohugo.io/quick-reference/glossary/#method) . For example, a _page_ template receives a `Page` object, and the `Page` object provides methods to return values or perform actions. ### Current context Within a template, the dot (`.`) represents the current context. layouts/page.html{{ . }}
{{ end }} {{ with "baz" }}{{ . }}
{{ end }} In the example above, the context changes as we `range` through the [slice](https://gohugo.io/quick-reference/glossary/#slice) of values. In the first iteration the context is “foo”, and in the second iteration the context is “bar”. Inside of the `with` block the context is “baz”. Hugo renders the above to:foo
bar
baz
### Template context Within a `range` or `with` block you can access the context passed into the template by prepending a dollar sign (`$`) to the dot: layouts/page.html {{ with "foo" }}{{ $.Title }} - {{ . }}
{{ end }} Hugo renders this to:My Page Title - foo
Make sure that you thoroughly understand the concept of _context_ before you continue reading. The most common templating errors made by new users relate to context. Actions ------- In the examples above, the paired opening and closing braces represent the beginning and end of a template action, a data evaluation or control structure within a template. A template action may contain literal values ([boolean](https://gohugo.io/quick-reference/glossary/#boolean) , [string](https://gohugo.io/quick-reference/glossary/#string) , [integer](https://gohugo.io/quick-reference/glossary/#integer) , and [float](https://gohugo.io/quick-reference/glossary/#float) ), the [current context](https://gohugo.io/templates/introduction/#current-context) , [variables](https://gohugo.io/templates/introduction/#variables) , [functions](https://gohugo.io/templates/introduction/#functions) , [methods](https://gohugo.io/templates/introduction/#methods) , and the [`nil`](https://gohugo.io/templates/introduction/#nil) keyword. layouts/page.html {{ $convertToLower := true }} {{ if $convertToLower }}42 is greater than nil
{{ end }} {{ $pages := where .Site.RegularPages "Params.color" "ne" nil }} These, on the other hand, are invalid: {{ $a := nil }} {{ add 3 nil }} {{ nil | print}} The actions above throw an error. Variables --------- A variable is a user-defined [identifier](https://gohugo.io/quick-reference/glossary/#identifier) prepended with a dollar sign (`$`), representing a value of any data type, initialized or assigned within a template action. For example, `$foo` and `$bar` are variables. Variables may contain [scalars](https://gohugo.io/quick-reference/glossary/#scalar) , [slices](https://gohugo.io/quick-reference/glossary/#slice) , [maps](https://gohugo.io/quick-reference/glossary/#map) , or [objects](https://gohugo.io/quick-reference/glossary/#object) . Use `:=` to initialize a variable, and use `=` to assign a value to a variable that has been previously initialized. For example: {{ $total := 3 }} {{ range slice 7 11 21 }} {{ $total = add $total . }} {{ end }} {{ $total }} → 42 Variables initialized inside of an `if`, `range`, or `with` block are scoped to the block. Variables initialized outside of these blocks are scoped to the template. With variables that represent a slice or map, use the [`index`](https://gohugo.io/functions/collections/indexfunction/) function to return the desired value. {{ $slice := slice "foo" "bar" "baz" }} {{ index $slice 2 }} → baz {{ $map := dict "a" "foo" "b" "bar" "c" "baz" }} {{ index $map "c" }} → baz Slices and arrays are zero-based; element 0 is the first element. With variables that represent a map or object, [chain](https://gohugo.io/quick-reference/glossary/#chain) identifiers to return the desired value or to access the desired method. {{ $map := dict "a" "foo" "b" "bar" "c" "baz" }} {{ $map.c }} → baz {{ $homePage := .Site.Home }} {{ $homePage.Title }} → My Homepage As seen above, object and method names are capitalized. Although not required, to avoid confusion we recommend beginning variable and map key names with a lowercase letter or underscore. Functions --------- Used within a template action, a function takes one or more arguments and returns a value. Unlike methods, functions are not associated with an object. Go’s `text/template` and `html/template` packages provide a small set of functions, operators, and statements for general use. See the [go-templates](https://gohugo.io/functions/go-template/) section of the function documentation for details. Hugo provides hundreds of custom [functions](https://gohugo.io/functions/) categorized by namespace. For example, the `strings` namespace includes these and other functions: | Function | Alias | | --- | --- | | [`strings.ToLower`](https://gohugo.io/functions/strings/tolower/) | `lower` | | [`strings.ToUpper`](https://gohugo.io/functions/strings/toupper/) | `upper` | | [`strings.Replace`](https://gohugo.io/functions/strings/replace/) | `replace` | As shown above, frequently used functions have an alias. Use aliases in your templates to reduce code length. When calling a function, separate the arguments from the function, and from each other, with a space. For example: {{ $total := add 1 2 3 4 }} Methods ------- Used within a template action and associated with an object, a method takes zero or more arguments and either returns a value or performs an action. The most commonly accessed objects are the [`Page`](https://gohugo.io/methods/page/) and [`Site`](https://gohugo.io/methods/site/) objects. This is a small sampling of the [methods](https://gohugo.io/methods/) available to each object. | Object | Method | Description | | --- | --- | --- | | `Page` | [`Date`](https://gohugo.io/methods/page/date/) | Returns the date of the given page. | | `Page` | [`Params`](https://gohugo.io/methods/page/params/) | Returns a map of custom parameters as defined in the front matter of the given page. | | `Page` | [`Title`](https://gohugo.io/methods/page/title/) | Returns the title of the given page. | | `Site` | [`Data`](https://gohugo.io/methods/site/data/) | Returns a data structure composed from the files in the `data` directory. | | `Site` | [`Params`](https://gohugo.io/methods/site/params/) | Returns a map of custom parameters as defined in your project configuration. | | `Site` | [`Title`](https://gohugo.io/methods/site/title/) | Returns the title as defined in the your project configuration. | Chain the method to its object with a dot (`.`) as shown below, remembering that the leading dot represents the [current context](https://gohugo.io/templates/introduction/#current-context) . layouts/page.html {{ .Site.Title }} → My Site Title {{ .Page.Title }} → My Page Title The context passed into most templates is a `Page` object, so this is equivalent to the previous example: layouts/page.html {{ .Site.Title }} → My Site Title {{ .Title }} → My Page Title Some methods take an argument. Separate the argument from the method with a space. For example: layouts/page.html {{ $page := .Page.GetPage "/books/les-miserables" }} {{ $page.Title }} → Les Misérables Comments -------- Do not attempt to use HTML comment delimiters to comment out template code. Hugo strips HTML comments when rendering a page, but first evaluates any template code within the HTML comment delimiters. Depending on the template code within the HTML comment delimiters, this could cause unexpected results or fail the build. Template comments are similar to template actions. Paired opening and closing braces represent the beginning and end of a comment. For example: {{/* This is an inline comment. */}} {{- /* This is an inline comment with adjacent whitespace removed. */ -}} Code within a comment is not parsed, executed, or displayed. Comments may be inline, as shown above, or in block form: {{/* This is a block comment. */}} {{- /* This is a block comment with adjacent whitespace removed. */ -}} You may not nest one comment inside of another. To render an HTML comment, pass a string through the [`safeHTML`](https://gohugo.io/functions/safe/html/) template function. For example: {{ "" | safeHTML }} {{ printf "" .Site.Title | safeHTML }} Include ------- Use the [`template`](https://gohugo.io/functions/go-template/template/) function to include one or more of Hugo’s [embedded templates](https://gohugo.io/templates/embedded/) : {{ partial "google_analytics.html" . }} {{ partial "opengraph" . }} {{ partial "pagination.html" . }} {{ partial "schema.html" . }} {{ partial "twitter_cards.html" . }} Use the [`partial`](https://gohugo.io/functions/partials/include/) or [`partialCached`](https://gohugo.io/functions/partials/includecached/) function to include one or more [partial templates](https://gohugo.io/templates/types/#partial) : {{ partial "breadcrumbs.html" . }} {{ partialCached "css.html" . }} Create your _partial_ templates in the `layouts/_partials` directory. In the examples above, note that we are passing the current context (the dot) to each of the templates. Examples -------- This limited set of contrived examples demonstrates some of concepts described above. Please see the [functions](https://gohugo.io/functions/) , [methods](https://gohugo.io/methods/) , and [templates](https://gohugo.io/templates/) documentation for specific examples. ### Conditional blocks See documentation for [`if`](https://gohugo.io/functions/go-template/if/) , [`else`](https://gohugo.io/functions/go-template/else/) , and [`end`](https://gohugo.io/functions/go-template/end/) . {{ $var := 42 }} {{ if eq $var 6 }} {{ print "var is 6" }} {{ else if eq $var 7 }} {{ print "var is 7" }} {{ else if eq $var 42 }} {{ print "var is 42" }} {{ else }} {{ print "var is something else" }} {{ end }} ### Logical operators See documentation for [`and`](https://gohugo.io/functions/go-template/and/) and [`or`](https://gohugo.io/functions/go-template/or/) . {{ $v1 := true }} {{ $v2 := false }} {{ $v3 := false }} {{ $result := false }} {{ if and $v1 $v2 $v3 }} {{ $result = true }} {{ end }} {{ $result }} → false {{ if or $v1 $v2 $v3 }} {{ $result = true }} {{ end }} {{ $result }} → true ### Loops See documentation for [`range`](https://gohugo.io/functions/go-template/range/) , [`else`](https://gohugo.io/functions/go-template/else/) , and [`end`](https://gohugo.io/functions/go-template/end/) . {{ $s := slice "foo" "bar" "baz" }} {{ range $s }}{{ . }}
{{ else }}The collection is empty
{{ end }} To loop a specified number of times: {{ $s := slice }} {{ range 3 }} {{ $s = $s | append . }} {{ end }} {{ $s }} → [0 1 2] ### Rebind context See documentation for [`with`](https://gohugo.io/functions/go-template/with/) , [`else`](https://gohugo.io/functions/go-template/else/) , and [`end`](https://gohugo.io/functions/go-template/end/) . {{ $var := "foo" }} {{ with $var }} {{ . }} → foo {{ else }} {{ print "var is falsy" }} {{ end }} To test multiple conditions: {{ $v1 := 0 }} {{ $v2 := 42 }} {{ with $v1 }} {{ . }} {{ else with $v2 }} {{ . }} → 42 {{ else }} {{ print "v1 and v2 are falsy" }} {{ end }} ### Access site parameters See documentation for the [`Params`](https://gohugo.io/methods/site/params/) method on a `Site` object. With this project configuration: baseURL: https://example.org params: author: email: jsmith@example.org name: John Smith copyright-year: '2023' layouts: rfc_1123: Mon, 02 Jan 2006 15:04:05 MST rfc_3339: '2006-01-02T15:04:05-07:00' subtitle: The Best Widgets on Earth title: ABC Widgets baseURL = 'https://example.org' title = 'ABC Widgets' [params] copyright-year = '2023' subtitle = 'The Best Widgets on Earth' [params.author] email = 'jsmith@example.org' name = 'John Smith' [params.layouts] rfc_1123 = 'Mon, 02 Jan 2006 15:04:05 MST' rfc_3339 = '2006-01-02T15:04:05-07:00' { "baseURL": "https://example.org", "params": { "author": { "email": "jsmith@example.org", "name": "John Smith" }, "copyright-year": "2023", "layouts": { "rfc_1123": "Mon, 02 Jan 2006 15:04:05 MST", "rfc_3339": "2006-01-02T15:04:05-07:00" }, "subtitle": "The Best Widgets on Earth" }, "title": "ABC Widgets" } Access the custom site parameters by chaining the identifiers: {{ .Site.Params.subtitle }} → The Best Widgets on Earth {{ .Site.Params.author.name }} → John Smith {{ $layout := .Site.Params.layouts.rfc_1123 }} {{ .Site.Lastmod.Format $layout }} → Tue, 17 Oct 2023 13:21:02 PDT ### Access page parameters See documentation for the [`Params`](https://gohugo.io/methods/page/params/) method on a `Page` object. By way of example, consider this front matter: --- date: 2023-10-17T15:11:37-07:00 params: author: email: jsmith@example.org name: John Smith display_related: true key-with-hyphens: must use index function title: Annual conference --- +++ date = 2023-10-17T15:11:37-07:00 title = 'Annual conference' [params] display_related = true key-with-hyphens = 'must use index function' [params.author] email = 'jsmith@example.org' name = 'John Smith' +++ { "date": "2023-10-17T15:11:37-07:00", "params": { "author": { "email": "jsmith@example.org", "name": "John Smith" }, "display_related": true, "key-with-hyphens": "must use index function" }, "title": "Annual conference" } The `title` and `date` fields are standard [front matter fields](https://gohugo.io/content-management/front-matter/#fields) , while the other fields are user-defined. Access the custom fields by [chaining](https://gohugo.io/quick-reference/glossary/#chain) the [identifiers](https://gohugo.io/quick-reference/glossary/#identifier) when needed: {{ .Params.display_related }} → true {{ .Params.author.email }} → jsmith@example.org {{ .Params.author.name }} → John Smith In the template example above, each of the keys is a valid identifier. For example, none of the keys contains a hyphen. To access a key that is not a valid identifier, use the [`index`](https://gohugo.io/functions/collections/indexfunction/) function: {{ index .Params "key-with-hyphens" }} → must use index function * * * Last updated: February 27, 2026 : [content: Miscellaneous udpates for v0.157.0 (35da1aa3c)](https://github.com/gohugoio/hugoDocs/commit/35da1aa3c2fe3b54bdb57df1a308533844af9df5) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/templates/introduction.md) --- # Cast functions Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  [### cast.ToFloat\ \ cast.ToFloat INPUT\ \ Converts a value to a decimal floating-point number (base 10).](https://gohugo.io/functions/cast/tofloat/) [### cast.ToInt\ \ cast.ToInt INPUT\ \ Converts a value to a decimal integer (base 10).](https://gohugo.io/functions/cast/toint/) [### cast.ToString\ \ cast.ToString INPUT\ \ Converts a value to a string.](https://gohugo.io/functions/cast/tostring/) --- # ByName Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Returns the given menu with its entries sorted by name. Syntax MENU.ByName Returns navigation.Menu The `Sort` method returns the given menu with its entries sorted by `name`. Consider this menu definition: menus: main: - name: Services pageRef: /services weight: 10 - name: About pageRef: /about weight: 20 - name: Contact pageRef: /contact weight: 30 [menus] [[menus.main]] name = 'Services' pageRef = '/services' weight = 10 [[menus.main]] name = 'About' pageRef = '/about' weight = 20 [[menus.main]] name = 'Contact' pageRef = '/contact' weight = 30 { "menus": { "main": [\ {\ "name": "Services",\ "pageRef": "/services",\ "weight": 10\ },\ {\ "name": "About",\ "pageRef": "/about",\ "weight": 20\ },\ {\ "name": "Contact",\ "pageRef": "/contact",\ "weight": 30\ }\ ] } } To sort the entries by `name`:{{ .Text }}To render a blockquote as an HTML `figure` element with an optional citation and caption: layouts/\_markup/render-blockquote.html
{{ .Text }}{{ with .Attributes.caption }}
{{ else }}{{ transform.Emojify (index $emojis .AlertType) }} {{ with .AlertTitle }} {{ . }} {{ else }} {{ or (i18n .AlertType) (title .AlertType) }} {{ end }}
{{ .Text }}
{{ .Text }}{{ end }} To override the label, create these entries in your i18n files: caution: Caution important: Important note: Note tip: Tip warning: Warning caution = 'Caution' important = 'Important' note = 'Note' tip = 'Tip' warning = 'Warning' { "caution": "Caution", "important": "Important", "note": "Note", "tip": "Tip", "warning": "Warning" } Although you can use one template with conditional logic as shown above, you can also create separate templates for each [`Type`](https://gohugo.io/render-hooks/blockquotes/#type) of blockquote: layouts/ └── _markup/ ├── render-blockquote-alert.html └── render-blockquote-regular.html PageInner details ----------------- The primary use case for `PageInner` is to resolve links and [page resources](https://gohugo.io/quick-reference/glossary/#page-resource) relative to an included `Page`. For example, create an “include” shortcode to compose a page from multiple content files, while preserving a global context for footnotes and the table of contents: layouts/\_shortcodes/include.html {{ with .Get 0 }} {{ with $.Page.GetPage . }} {{- .RenderShortcodes }} {{ else }} {{ errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }} {{ end }} {{ else }} {{ errorf "The %q shortcode requires a positional parameter indicating the logical path of the file to include. See %s" .Name .Position }} {{ end }} Then call the shortcode in your Markdown: content/posts/post-1.md {{% include "/posts/post-2" %}} Any render hook triggered while rendering `/posts/post-2` will get: * `/posts/post-1` when calling `Page` * `/posts/post-2` when calling `PageInner` `PageInner` falls back to the value of `Page` if not relevant, and always returns a value. The `PageInner` method is only relevant for shortcodes that invoke the [`RenderShortcodes`](https://gohugo.io/methods/page/rendershortcodes/) method, and you must call the shortcode using [Markdown notation](https://gohugo.io/content-management/shortcodes/#notation) . As a practical example, Hugo’s embedded link and image render hooks use the `PageInner` method to resolve markdown link and image destinations. See the source code for each: * [Embedded link render hook](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_markup/render-link.html) * [Embedded image render hook](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_markup/render-image.html) * * * Last updated: August 23, 2025 : [Merge commit 'bfa74537929f409fca841540b971125b7678963a' (6c911d1e5)](https://github.com/gohugoio/hugoDocs/commit/6c911d1e52fb9c8065c079820327f4b0e37529d4) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/render-hooks/blockquotes.md) --- # Embedded partial templates Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Hugo provides embedded partial templates for common use cases. We did a complete overhaul of Hugo’s template system in v0.146.0. We’re working on getting all of the relevant documentation up to date, but until then, see [this page](https://gohugo.io/templates/new-templatesystem-overview/) . Disqus ------ To override Hugo’s embedded Disqus template, copy the [source code](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/disqus.html) to a file with the same name in the `layouts/_partials` directory, then call it from your templates using the [`partial`](https://gohugo.io/functions/partials/include/) function: `{{ partial "disqus.html" . }}` Hugo includes an embedded template for [Disqus](https://disqus.com/) , a popular commenting system for both static and dynamic websites. To effectively use Disqus, secure a Disqus “shortname” by [signing up](https://disqus.com/profile/signup/) for the free service. To include the embedded template: {{ partial "disqus.html" . }} ### Configuration To use Hugo’s Disqus template, first set up a single configuration value: services: disqus: shortname: your-disqus-shortname [services] [services.disqus] shortname = 'your-disqus-shortname' { "services": { "disqus": { "shortname": "your-disqus-shortname" } } } Hugo’s Disqus template accesses this value with: {{ .Site.Config.Services.Disqus.Shortname }} You can also set the following in the front matter for a given piece of content: * `disqus_identifier` * `disqus_title` * `disqus_url` ### Privacy Adjust the relevant privacy settings in your project configuration. privacy: disqus: disable: false [privacy] [privacy.disqus] disable = false { "privacy": { "disqus": { "disable": false } } } disable (`bool`) Whether to disable the template. Default is `false`. Google Analytics ---------------- To override Hugo’s embedded Google Analytics template, copy the [source code](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/google_analytics.html) to a file with the same name in the `layouts/_partials` directory, then call it from your templates using the [`partial`](https://gohugo.io/functions/partials/include/) function: `{{ partial "google_analytics.html" . }}` Hugo includes an embedded template supporting [Google Analytics 4](https://support.google.com/analytics/answer/10089681) . To include the embedded template: {{ partial "google_analytics.html" . }} ### Configuration Provide your tracking ID in your configuration file: services: googleAnalytics: id: G-MEASUREMENT_ID [services] [services.googleAnalytics] id = 'G-MEASUREMENT_ID' { "services": { "googleAnalytics": { "id": "G-MEASUREMENT_ID" } } } To use this value in your own template, access the configured ID with `{{ site.Config.Services.GoogleAnalytics.ID }}`. ### Privacy Adjust the relevant privacy settings in your project configuration. privacy: googleAnalytics: disable: false respectDoNotTrack: true [privacy] [privacy.googleAnalytics] disable = false respectDoNotTrack = true { "privacy": { "googleAnalytics": { "disable": false, "respectDoNotTrack": true } } } disable (`bool`) Whether to disable the template. Default is `false`. respectDoNotTrack (`bool`) Whether to respect the browser’s “do not track” setting. Default is `true`. Open Graph ---------- To override Hugo’s embedded Open Graph template, copy the [source code](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/opengraph.html) to a file with the same name in the `layouts/_partials` directory, then call it from your templates using the [`partial`](https://gohugo.io/functions/partials/include/) function: `{{ partial "opengraph.html" . }}` Hugo includes an embedded template for the [Open Graph protocol](https://ogp.me/) , metadata that enables a page to become a rich object in a social graph. This format is used for Facebook and some other sites. To include the embedded template: {{ partial "opengraph.html" . }} ### Configuration Hugo’s Open Graph template is configured using a mix of configuration settings and [front matter](https://gohugo.io/content-management/front-matter/) on individual pages. params: description: Text about my cool site images: - site-feature-image.jpg social: facebook_admin: jsmith title: My cool site taxonomies: series: series [params] description = 'Text about my cool site' images = ['site-feature-image.jpg'] title = 'My cool site' [params.social] facebook_admin = 'jsmith' [taxonomies] series = 'series' { "params": { "description": "Text about my cool site", "images": [\ "site-feature-image.jpg"\ ], "social": { "facebook_admin": "jsmith" }, "title": "My cool site" }, "taxonomies": { "series": "series" } } --- audio: [] date: 2024-03-08T08:18:11-08:00 description: Text about this post images: - post-cover.png series: [] tags: [] title: Post title videos: [] --- +++ audio = [] date = 2024-03-08T08:18:11-08:00 description = 'Text about this post' images = ['post-cover.png'] series = [] tags = [] title = 'Post title' videos = [] +++ { "audio": [], "date": "2024-03-08T08:18:11-08:00", "description": "Text about this post", "images": [\ "post-cover.png"\ ], "series": [], "tags": [], "title": "Post title", "videos": [] } Hugo uses the page title and description for the title and description metadata. The first 6 URLs from the `images` array are used for image metadata. If [page bundles](https://gohugo.io/content-management/page-bundles/) are used and the `images` array is empty or undefined, images with file names matching `*feature*`, `*cover*`, or `*thumbnail*` are used for image metadata. Various optional metadata can also be set: * Date, published date, and last modified data are used to set the published time metadata if specified. * `audio` and `videos` are URL arrays like `images` for the audio and video metadata tags, respectively. * The first 6 `tags` on the page are used for the tags metadata. * The `series` taxonomy is used to specify related “see also” pages by placing them in the same series. If using YouTube this will produce a og:video tag like ``. Use the `https://youtu.be/
{{ debug.Dump $taxonomyObject }}
Although the [`Alphabetical`](https://gohugo.io/methods/taxonomy/alphabetical/)
and [`ByCount`](https://gohugo.io/methods/taxonomy/bycount/)
methods provide a better data structure for ranging through the taxonomy, you can render the weighted pages by term directly from the `Taxonomy` object:
{{ range $term, $weightedPages := $taxonomyObject }}
{{ debug.Dump $taxonomyObject.ByCount }}
An ordered taxonomy is a slice, where each element is an object that contains the term and a slice of its weighted pages.
Each element of the slice provides these methods:
Count
(`int`) Returns the number of pages to which the term is assigned.
Page
(`page.Page`) Returns the term’s `Page` object, useful for linking to the term page.
Pages
(`page.Pages`) Returns a `Pages` object containing the `Page` objects to which the term is assigned, sorted by [taxonomic weight](https://gohugo.io/quick-reference/glossary/#taxonomic-weight)
. To sort or group, use any of the [methods](https://gohugo.io/methods/pages/)
available to the `Pages` object. For example, sort by the last modification date.
Term
(`string`) Returns the term name.
WeightedPages
(`page.WeightedPages`) Returns a slice of weighted pages to which the term is assigned, sorted by taxonomic weight. The `Pages` method above is more flexible, allowing you to sort and group.
Example
-------
With this template:
{{ range $taxonomyObject.ByCount }}
{{ . }}
{{ end }} Is rendered to:foo
See Go’s [`text/template`](https://pkg.go.dev/text/template) documentation for more information. * * * Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/go-template/break.md) --- # block Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Defines a template and executes it in place. Syntax block NAME CONTEXT A block is shorthand for defining a template: {{ define "name" }} T1 {{ end }} and then executing it in place: {{ template "name" pipeline }} The typical use is to define a set of root templates that are then customized by redefining the block templates within. layouts/baseof.html
{{ .Inner | htmlEscape | safeHTML }}
{{ .Page.Store.Set "hasMermaid" true }}
Then include this snippet at the _bottom_ of your base template, before the closing `body` tag:
layouts/baseof.html
{{ if .Store.Get "hasMermaid" }}
{{ end }}
See the [diagrams](https://gohugo.io/content-management/diagrams/#mermaid-diagrams)
page for details.
Embedded
--------
Hugo includes an [embedded code block render hook](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_markup/render-codeblock-goat.html)
to render [GoAT diagrams](https://gohugo.io/content-management/diagrams/#goat-diagrams-ascii)
.
PageInner details
-----------------
The primary use case for `PageInner` is to resolve links and [page resources](https://gohugo.io/quick-reference/glossary/#page-resource)
relative to an included `Page`. For example, create an “include” shortcode to compose a page from multiple content files, while preserving a global context for footnotes and the table of contents:
layouts/\_shortcodes/include.html
{{ with .Get 0 }}
{{ with $.Page.GetPage . }}
{{- .RenderShortcodes }}
{{ else }}
{{ errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
{{ end }}
{{ else }}
{{ errorf "The %q shortcode requires a positional parameter indicating the logical path of the file to include. See %s" .Name .Position }}
{{ end }}
Then call the shortcode in your Markdown:
content/posts/post-1.md
{{% include "/posts/post-2" %}}
Any render hook triggered while rendering `/posts/post-2` will get:
* `/posts/post-1` when calling `Page`
* `/posts/post-2` when calling `PageInner`
`PageInner` falls back to the value of `Page` if not relevant, and always returns a value.
The `PageInner` method is only relevant for shortcodes that invoke the [`RenderShortcodes`](https://gohugo.io/methods/page/rendershortcodes/)
method, and you must call the shortcode using [Markdown notation](https://gohugo.io/content-management/shortcodes/#notation)
.
As a practical example, Hugo’s embedded link and image render hooks use the `PageInner` method to resolve markdown link and image destinations. See the source code for each:
* [Embedded link render hook](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_markup/render-link.html)
* [Embedded image render hook](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_markup/render-image.html)
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/render-hooks/code-blocks.md)
---
# After
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Reports whether TIME1 is after TIME2.
Syntax
TIME1.After TIME2
Returns
bool
{{ $t1 := time.AsTime "2023-01-01T17:00:00-08:00" }}
{{ $t2 := time.AsTime "2010-01-01T17:00:00-08:00" }}
{{ $t1.After $t2 }} → true
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/time/After.md)
---
# AddDate
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns the time corresponding to adding the given number of years, months, and days to the given time.Time value.
Syntax
TIME.AddDate YEARS MONTHS DAYS
Returns
time.Time
{{ $d := "2022-01-01" | time.AsTime }}
{{ $d.AddDate 0 0 1 | time.Format "2006-01-02" }} → 2022-01-02
{{ $d.AddDate 0 1 1 | time.Format "2006-01-02" }} → 2022-02-02
{{ $d.AddDate 1 1 1 | time.Format "2006-01-02" }} → 2023-02-02
{{ $d.AddDate -1 -1 -1 | time.Format "2006-01-02" }} → 2020-11-30
When adding months or years, Hugo normalizes the final `time.Time` value if the resulting day does not exist. For example, adding one month to 31 January produces 2 March or 3 March, depending on the year.
See [this explanation](https://github.com/golang/go/issues/31145#issuecomment-479067967)
from the Go team.
{{ $d := "2023-01-31" | time.AsTime }}
{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2023-03-03
{{ $d := "2024-01-31" | time.AsTime }}
{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2024-03-02
{{ $d := "2024-02-29" | time.AsTime }}
{{ $d.AddDate 1 0 0 | time.Format "2006-01-02" }} → 2025-03-01
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/time/AddDate.md)
---
# AllPages
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a collection of all pages in all languages.
Syntax
SITE.AllPages
Returns
page.Pages
Deprecated in [v0.156.0](https://github.com/gohugoio/hugo/releases/tag/v0.156.0)
See [details](https://discourse.gohugo.io/t/56732)
.
* * *
Last updated: March 2, 2026 : [content: Clean up content for deprecated features (850dc5b2b)](https://github.com/gohugoio/hugoDocs/commit/850dc5b2b26b7136504b24a46d6abede248c0fed)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/site/AllPages.md)
---
# All settings
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
The complete list of Hugo configuration settings.
Settings
--------
archetypeDir
(`string`) The designated directory for [archetypes](https://gohugo.io/quick-reference/glossary/#archetype)
. Default is `archetypes`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
assetDir
(`string`) The designated directory for [global resources](https://gohugo.io/quick-reference/glossary/#global-resource)
. Default is `assets`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
baseURL
(`string`) The absolute URL of your published site including the protocol, host, path, and a trailing slash.
build
See [configure build](https://gohugo.io/configuration/build/)
.
buildDrafts
(`bool`) Whether to include draft content when building a site. Default is `false`.
buildExpired
(`bool`) Whether to include expired content when building a site. Default is `false`.
buildFuture
(`bool`) Whether to include future content when building a site. Default is `false`.
cacheDir
(`string`) The designated cache directory. See [details](https://gohugo.io/configuration/all/#cache-directory)
.
caches
See [configure file caches](https://gohugo.io/configuration/caches/)
.
canonifyURLs
(`bool`) See [details](https://gohugo.io/content-management/urls/#canonical-urls)
before enabling this feature. Default is `false`.
capitalizeListTitles
(`bool`) Whether to capitalize automatic list titles. Applicable to section, taxonomy, and term pages. Use the [`titleCaseStyle`](https://gohugo.io/configuration/all/#titlecasestyle)
setting to configure capitalization rules. Default is `true`.
cascade
See [configure cascade](https://gohugo.io/configuration/cascade/)
.
cleanDestinationDir
(`bool`) Whether to remove files from the [`publishDir`](https://gohugo.io/configuration/all/#publishdir)
that do not exist in the [`staticDir`](https://gohugo.io/configuration/all/#staticdir)
when building the site. This setting will not take effect if the `staticDir` does not exist. Note that `.gitignore` and `.gitattributes` files, along with directories named `.git`, are always preserved in the `publishDir`. Default is `false`.
contentDir
(`string`) The designated directory for content files. Default is `content`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
copyright
(`string`) The copyright notice for a site, typically displayed in the footer.
dataDir
(`string`) The designated directory for data files. Default is `data`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
defaultContentLanguage
(`string`) The projects’s [default language](https://gohugo.io/quick-reference/glossary/#default-language)
, conforming to the syntax described in [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646#section-2.1)
.
defaultContentLanguageInSubdir
(`bool`) Whether to publish the default content language to a subdirectory matching the [`defaultContentLanguage`](https://gohugo.io/configuration/all/#defaultcontentlanguage)
. Default is `false`.
defaultContentRole
[New in v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0)
(`string`) The project’s [default role](https://gohugo.io/quick-reference/glossary/#default-role)
.
defaultContentRoleInSubdir
[New in v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0)
(`bool`) Whether to publish the default content [role](https://gohugo.io/quick-reference/glossary/#role)
to a subdirectory matching the [`defaultContentRole`](https://gohugo.io/configuration/all/#defaultcontentrole)
. Default is `false`.
defaultContentVersion
[New in v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0)
(`string`) The project’s [default version](https://gohugo.io/quick-reference/glossary/#default-version)
.
defaultContentVersionInSubdir
[New in v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0)
(`bool`) Whether to publish the default content version to a subdirectory matching the [`defaultContentVersion`](https://gohugo.io/configuration/all/#defaultcontentversion)
. Default is `false`.
defaultOutputFormat
(`string`) The default output format for the site. If unspecified, the first available format in the defined order (by weight, then alphabetically) will be used.
deployment
See [configure deployment](https://gohugo.io/configuration/deployment/)
.
disableAliases
(`bool`) Whether to disable the generation of HTML redirect files for each path defined in the [`aliases`](https://gohugo.io/content-management/front-matter/#aliases)
front matter field. When `true`, Hugo will not create physical files for [client-side redirection](https://gohugo.io/content-management/urls/#client-side-redirection)
, but the alias data remains available via the [`Aliases`](https://gohugo.io/methods/page/aliases/)
method on a `Page` object. Default is `false`.
disableDefaultLanguageRedirect
[New in v0.140.0](https://github.com/gohugoio/hugo/releases/tag/v0.140.0)
(`bool`) Whether to disable generation of the alias redirect for the default content language. When [`defaultContentLanguageInSubdir`](https://gohugo.io/configuration/all/#defaultcontentlanguageinsubdir)
is `true`, this setting prevents the root directory from redirecting to the language subdirectory. Conversely, when `defaultContentLanguageInSubdir` is `false`, this setting prevents the language subdirectory from redirecting to the root directory. This is superseded by the more general [`disableDefaultSiteRedirect`](https://gohugo.io/configuration/all/#disabledefaultsiteredirect)
setting. Default is `false`.
disableDefaultSiteRedirect
[New in v0.154.5](https://github.com/gohugoio/hugo/releases/tag/v0.154.5)
(bool) Whether to disable generation of the alias redirect to the [default site](https://gohugo.io/quick-reference/glossary/#default-site)
. When [`defaultContentLanguageInSubdir`](https://gohugo.io/configuration/all/#defaultcontentlanguageinsubdir)
, [`defaultContentRoleInSubdir`](https://gohugo.io/configuration/all/#defaultcontentroleinsubdir)
, or [`defaultContentVersionInSubdir`](https://gohugo.io/configuration/all/#defaultcontentversioninsubdir)
is `true`, this prevents the root directory from redirecting to the default site’s subdirectory. Conversely, when these are `false`, it prevents the subdirectories from redirecting back to the root. Default is `false`.
disableHugoGeneratorInject
(`bool`) Whether to disable injection of a `` tag into the home page. Default is `false`.
disableKinds
(`[]string`) A slice of page [kinds](https://gohugo.io/quick-reference/glossary/#kind)
to disable during the build process, any of `404`, `home`, `page`, `robotstxt`, `rss`, `section`, `sitemap`, `taxonomy`, or `term`.
disableLanguages
(`[]string`) A slice of language keys representing the languages to disable during the build process. Although this is functional, consider using the [`disabled`](https://gohugo.io/configuration/languages/#disabled)
key under each language instead.
disableLiveReload
(`bool`) Whether to disable automatic live reloading of the browser window. Default is `false`.
disablePathToLower
(`bool`) Whether to disable transformation of page URLs to lower case. Default is `false`.
enableEmoji
(`bool`) Whether to allow emoji in Markdown. Default is `false`.
enableGitInfo
(`bool`) Whether to retrieve commit metadata from the Git history of your local project and any [modules](https://gohugo.io/quick-reference/glossary/#module)
. This enables the [`GitInfo`](https://gohugo.io/methods/page/gitinfo/)
method on a `Page` object. With the default front matter configuration, the [`Lastmod`](https://gohugo.io/methods/page/lastmod/)
method on a `Page` object returns the Git author date of the last commit for that file. Default is `false`.
enableMissingTranslationPlaceholders
(`bool`) Whether to show a placeholder instead of the default value or an empty string if a translation is missing. Default is `false`.
enableRobotsTXT
(`bool`) Whether to enable generation of a `robots.txt` file. Default is `false`.
environment
(`string`) The build environment. Default is `production` when running `hugo build` and `development` when running `hugo server`.
frontmatter
See [configure front matter](https://gohugo.io/configuration/front-matter/)
.
hasCJKLanguage
(`bool`) Whether to automatically detect [CJK](https://gohugo.io/quick-reference/glossary/#cjk)
languages in content. Affects the values returned by the [`WordCount`](https://gohugo.io/methods/page/wordcount/)
and [`FuzzyWordCount`](https://gohugo.io/methods/page/fuzzywordcount/)
methods. Default is `false`.
HTTPCache
See [configure HTTP cache](https://gohugo.io/configuration/http-cache/)
.
i18nDir
(`string`) The designated directory for translation tables. Default is `i18n`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
ignoreCache
(`bool`) Whether to ignore the cache directory. Default is `false`.
ignoreFiles
(`[]string`) A slice of [regular expressions](https://gohugo.io/quick-reference/glossary/#regular-expression)
used to exclude specific files from a build. These expressions are matched against the absolute file path and apply to files within the `content`, `data`, and `i18n` directories. For more advanced file exclusion options, see the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
ignoreLogs
(`[]string`) A slice of message identifiers corresponding to warnings and errors you wish to suppress. See [`erroridf`](https://gohugo.io/functions/fmt/erroridf/)
and [`warnidf`](https://gohugo.io/functions/fmt/warnidf/)
.
ignoreVendorPaths
(`string`) A [glob pattern](https://gohugo.io/quick-reference/glossary/#glob-pattern)
matching the module paths to exclude from the `_vendor` directory.
imaging
See [configure imaging](https://gohugo.io/configuration/imaging/)
.
languageCode
(`string`) The site’s language tag, conforming to the syntax described in [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646#section-2.1)
. This value does not affect translations or localization. Hugo uses this value to populate:
* The `language` element in the [embedded RSS template](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/rss.xml)
* The `lang` attribute of the `html` element in the [embedded alias template](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/alias.html)
* The `og:locale` `meta` element in the [embedded Open Graph template](https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/opengraph.html)
When present in the root of the configuration, this value is ignored if one or more language keys exists. Please specify this value independently for each language key.
languages
See [configure languages](https://gohugo.io/configuration/languages/)
.
layoutDir
(`string`) The designated directory for templates. Default is `layouts`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
mainSections
(`string` or `[]string`) The main sections of a site. If set, the [`MainSections`](https://gohugo.io/methods/site/mainsections/)
method on the `Site` object returns the given sections, otherwise it returns the section with the most pages.
markup
See [configure markup](https://gohugo.io/configuration/markup/)
.
mediaTypes
See [configure media types](https://gohugo.io/configuration/media-types/)
.
menus
See [configure menus](https://gohugo.io/configuration/menus/)
.
minify
See [configure minify](https://gohugo.io/configuration/minify/)
.
module
See [configure modules](https://gohugo.io/configuration/module/)
.
newContentEditor
(`string`) The editor to use when creating new content.
noBuildLock
(`bool`) Whether to disable creation of the `.hugo_build.lock` file. Default is `false`.
noChmod
(`bool`) Whether to disable synchronization of file permission modes. Default is `false`.
noTimes
(`bool`) Whether to disable synchronization of file modification times. Default is `false`.
outputFormats
See [configure output formats](https://gohugo.io/configuration/output-formats/)
.
outputs
See [configure outputs](https://gohugo.io/configuration/outputs/)
.
page
See [configure page](https://gohugo.io/configuration/page/)
.
pagination
See [configure pagination](https://gohugo.io/configuration/pagination/)
.
panicOnWarning
(`bool`) Whether to panic on the first WARNING. Default is `false`.
params
See [configure params](https://gohugo.io/configuration/params/)
.
permalinks
See [configure permalinks](https://gohugo.io/configuration/permalinks/)
.
pluralizeListTitles
(`bool`) Whether to pluralize automatic list titles. Applicable to section pages. Default is `true`.
printI18nWarnings
(`bool`) Whether to log WARNINGs for each missing translation. Default is `false`.
printPathWarnings
(`bool`) Whether to log WARNINGs when Hugo publishes two or more files to the same path. Default is `false`.
printUnusedTemplates
(`bool`) Whether to log WARNINGs for each unused template. Default is `false`.
privacy
See [configure privacy](https://gohugo.io/configuration/privacy/)
.
publishDir
(`string`) The designated directory for publishing the site. Default is `public`.
refLinksErrorLevel
(`string`) The logging error level to use when the `ref` and `relref` functions, methods, and shortcodes are unable to resolve a reference to a page. Either `ERROR` or `WARNING`. Any `ERROR` will fail the build. Default is `ERROR`.
refLinksNotFoundURL
(`string`) The URL to return when the `ref` and `relref` functions, methods, and shortcodes are unable to resolve a reference to a page.
related
See [configure related content](https://gohugo.io/configuration/related-content/)
.
relativeURLs
(`bool`) See [details](https://gohugo.io/content-management/urls/#relative-urls)
before enabling this feature. Default is `false`.
removePathAccents
(`bool`) Whether to remove [non-spacing marks](https://www.compart.com/en/unicode/category/Mn)
from [composite characters](https://en.wikipedia.org/wiki/Precomposed_character)
in content paths. Default is `false`.
renderSegments
(`[]string`) A slice of [segments](https://gohugo.io/quick-reference/glossary/#segment)
to render. If omitted, all segments are rendered. This option is typically set via a command-line flag, such as `hugo build --renderSegments segment1,segment2`. The provided segment names must correspond to those defined in the [`segments`](https://gohugo.io/configuration/segments/)
configuration.
resourceDir
(`string`) The designated directory for caching output from [asset pipelines](https://gohugo.io/quick-reference/glossary/#asset-pipeline)
. Default is `resources`.
roles
See [configure roles](https://gohugo.io/configuration/roles/)
.
security
See [configure security](https://gohugo.io/configuration/security/)
.
sectionPagesMenu
(`string`) When set, each top-level section will be added to the menu identified by the provided value. See [details](https://gohugo.io/content-management/menus/#define-automatically)
.
segments
See [configure segments](https://gohugo.io/configuration/segments/)
.
server
See [configure server](https://gohugo.io/configuration/server/)
.
services
See [configure services](https://gohugo.io/configuration/services/)
.
sitemap
See [configure sitemap](https://gohugo.io/configuration/sitemap/)
.
staticDir
(`string`) The designated directory for static files. Default is `static`. For a more flexible approach to configuring this directory, consult the section on [module mounts](https://gohugo.io/configuration/module/#mounts)
.
summaryLength
(`int`) Applicable to [automatic summaries](https://gohugo.io/content-management/summaries/#automatic-summary)
, the minimum number of words returned by the [`Summary`](https://gohugo.io/methods/page/summary/)
method on a `Page` object. The `Summary` method will return content truncated at the paragraph boundary closest to the specified `summaryLength`, but at least this minimum number of words. Default is `70`.
taxonomies
See [configure taxonomies](https://gohugo.io/configuration/taxonomies/)
.
templateMetrics
(`bool`) Whether to print template execution metrics to the console. Default is `false`. See [details](https://gohugo.io/troubleshooting/performance/#template-metrics)
.
templateMetricsHints
(`bool`) Whether to print template execution improvement hints to the console. Applicable when `templateMetrics` is `true`. Default is `false`. See [details](https://gohugo.io/troubleshooting/performance/#template-metrics)
.
theme
(`string` or `[]string`) The [theme](https://gohugo.io/quick-reference/glossary/#theme)
to use. Multiple themes can be listed, with precedence given from left to right. See [details](https://gohugo.io/hugo-modules/theme-components/)
.
themesDir
(`string`) The designated directory for themes. Default is `themes`.
timeout
(`string`) The timeout for generating page content, either as a [duration](https://pkg.go.dev/time#Duration)
or in seconds. This timeout is used to prevent infinite recursion during content generation. You may need to increase this value if your pages take a long time to generate, for example, due to extensive image processing or reliance on remote content. Default is `60s`.
timeZone
(`string`) The time zone used to parse dates without time zone offsets, including front matter date fields and values passed to the [`time.AsTime`](https://gohugo.io/functions/time/astime/)
and [`time.Format`](https://gohugo.io/functions/time/format/)
template functions. The list of valid values may be system dependent, but should include `UTC`, `Local`, and any location in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
. For example, `America/Los_Angeles` and `Europe/Oslo` are valid time zones.
title
(`string`) The site title.
titleCaseStyle
(`string`) The capitalization rules to follow when Hugo automatically generates a section title, or when using the [`strings.Title`](https://gohugo.io/functions/strings/title/)
function. One of `ap`, `chicago`, `go`, `firstupper`, or `none`. Default is `ap`. See [details](https://gohugo.io/configuration/all/#title-case-style)
.
uglyurls
See [configure ugly URLs](https://gohugo.io/configuration/ugly-urls/)
.
versions
See [configure versions](https://gohugo.io/configuration/versions/)
.
Cache directory
---------------
Hugo’s file cache directory is configurable via the [`cacheDir`](https://gohugo.io/configuration/all/#cachedir)
configuration option or the `HUGO_CACHEDIR` environment variable. If neither is set, Hugo will use, in order of preference:
1. If running on Netlify: `/opt/build/cache/hugo_cache/`. This means that if you run your builds on Netlify, all caches configured with `:cacheDir` will be saved and restored on the next build. For other [CI/CD](https://gohugo.io/quick-reference/glossary/#cicd)
platforms, please read their documentation. For a CircleCI example, see [this configuration](https://github.com/bep/hugo-sass-test/blob/6c3960a8f4b90e8938228688bc49bdcdd6b2d99e/.circleci/config.yml)
.
2. In a `hugo_cache` directory below the OS user cache directory as defined by Go’s [os.UserCacheDir](https://pkg.go.dev/os#UserCacheDir)
function. On Unix systems, per the [XDG base directory specification](https://specifications.freedesktop.org/basedir-spec/latest/)
, this is `$XDG_CACHE_HOME` if non-empty, else `$HOME/.cache`. On MacOS, this is `$HOME/Library/Caches`. On Windows, this is`%LocalAppData%`. On Plan 9, this is `$home/lib/cache`.
3. In a `hugo_cache_$USER` directory below the OS temp dir.
To determine the current `cacheDir`:
hugo config | grep cachedir
Title case style
----------------
Hugo’s [`titleCaseStyle`](https://gohugo.io/configuration/all/#titlecasestyle)
setting governs capitalization for automatically generated section titles and the [`strings.Title`](https://gohugo.io/functions/strings/title/)
function. By default, it follows the capitalization rules published in the Associated Press Stylebook. Change this setting to use other capitalization rules.
ap
Use the capitalization rules published in the [Associated Press Stylebook](https://www.apstylebook.com/)
. This is the default.
chicago
Use the capitalization rules published in the [Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html)
.
go
Capitalize the first letter of every word.
firstupper
Capitalize the first letter of the first word.
none
Disable transformation of automatic section titles, and disable the transformation performed by the `strings.Title` function. This is useful if you would prefer to manually capitalize section titles as needed, and to bypass opinionated theme usage of the `strings.Title` function.
Localized settings
------------------
Some configuration settings, such as menus and custom parameters, can be defined separately for each language. See [configure languages](https://gohugo.io/configuration/languages/)
.
* * *
Last updated: February 27, 2026 : [content: Miscellaneous udpates for v0.157.0 (35da1aa3c)](https://github.com/gohugoio/hugoDocs/commit/35da1aa3c2fe3b54bdb57df1a308533844af9df5)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/configuration/all.md)
---
# Children
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a collection of child menu entries, if any, under the given menu entry.
Syntax
MENUENTRY.Children
Returns
navigation.Menu
Use the `Children` method when rendering a nested menu.
With this project configuration:
menus:
main:
- name: Products
pageRef: /product
weight: 10
- name: Product 1
pageRef: /products/product-1
parent: Products
weight: 1
- name: Product 2
pageRef: /products/product-2
parent: Products
weight: 2
[menus]
[[menus.main]]
name = 'Products'
pageRef = '/product'
weight = 10
[[menus.main]]
name = 'Product 1'
pageRef = '/products/product-1'
parent = 'Products'
weight = 1
[[menus.main]]
name = 'Product 2'
pageRef = '/products/product-2'
parent = 'Products'
weight = 2
{
"menus": {
"main": [\
{\
"name": "Products",\
"pageRef": "/product",\
"weight": 10\
},\
{\
"name": "Product 1",\
"pageRef": "/products/product-1",\
"parent": "Products",\
"weight": 1\
},\
{\
"name": "Product 2",\
"pageRef": "/products/product-2",\
"parent": "Products",\
"weight": 2\
}\
]
}
}
And this template:
### Other examples
For guidance, consider examining Hugo’s embedded shortcodes. The source code, available on [GitHub](https://github.com/gohugoio/hugo/tree/master/tpl/tplimpl/embedded/templates/_shortcodes)
, can provide a useful model.
Detection
---------
The [`HasShortcode`](https://gohugo.io/methods/page/hasshortcode/)
method allows you to check if a specific shortcode has been called on a page. For example, consider a custom audio shortcode:
content/example.md
{{< audio src=/audio/test.mp3 >}}
You can use the `HasShortcode` method in your base template to conditionally load CSS if the audio shortcode was used on the page:
layouts/baseof.html
...
{{ if .HasShortcode "audio" }}
{{ end }}
...
* * *
Last updated: February 27, 2026 : [content: Miscellaneous udpates for v0.157.0 (35da1aa3c)](https://github.com/gohugoio/hugoDocs/commit/35da1aa3c2fe3b54bdb57df1a308533844af9df5)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/templates/shortcode.md)
---
# Pagination
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Split a list page into two or more subsets.
Displaying a large page collection on a list page is not user-friendly:
* A massive list can be intimidating and difficult to navigate. Users may get lost in the sheer volume of information.
* Large pages take longer to load, which can frustrate users and lead to them abandoning the site.
* Without any filtering or organization, finding a specific item becomes a tedious scrolling exercise.
Improve usability by paginating `home`, `section`, `taxonomy`, and `term` pages.
The most common templating mistake related to pagination is invoking pagination more than once for a given list page. See the [caching](https://gohugo.io/templates/pagination/#caching)
section below.
Terminology
-----------
paginate
To split a [list page](https://gohugo.io/quick-reference/glossary/#list-page)
into two or more subsets.
pagination
The process of paginating a list page.
pager
Created during pagination, a pager contains a subset of a list page and navigation links to other pagers.
paginator
A collection of pagers.
Configuration
-------------
See [configure pagination](https://gohugo.io/configuration/pagination/)
.
Methods
-------
To paginate a `home`, `section`, `taxonomy`, or `term` page, invoke either of these methods on the `Page` object in the corresponding template:
* [`Paginate`](https://gohugo.io/methods/page/paginate/)
* [`Paginator`](https://gohugo.io/methods/page/paginator/)
The `Paginate` method is more flexible, allowing you to:
* Paginate any page collection
* Filter, sort, and group the page collection
* Override the number of pages per pager as defined in your project configuration
By comparison, the `Paginator` method paginates the page collection passed into the template, and you cannot override the number of pages per pager.
Examples
--------
To paginate a list page using the `Paginate` method:
{{ $pages := where site.RegularPages "Type" "posts" }}
{{ $paginator := .Paginate $pages.ByTitle 7 }}
{{ range $paginator.Pages }}
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/crypto/MD5.md)
---
# crypto.HMAC
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a cryptographic hash that uses a key to sign a message.
Syntax
crypto.HMAC HASH\_TYPE KEY MESSAGE \[ENCODING\]
Returns
string
Alias
hmac
Set the `HASH_TYPE` argument to `md5`, `sha1`, `sha256`, or `sha512`.
Set the optional `ENCODING` argument to either `hex` (default) or `binary`.
{{ hmac "sha256" "Secret key" "Secret message" }}
5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
{{ hmac "sha256" "Secret key" "Secret message" "hex" }}
5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
{{ hmac "sha256" "Secret key" "Secret message" "binary" | base64Encode }}
XM60kfRfixVOIPOwow7Tpv8wJ9Nz+Fx4/+iYMYCwPIQ=
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/crypto/HMAC.md)
---
# crypto.SHA1
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Hashes the given input and returns its SHA1 checksum encoded to a hexadecimal string.
Syntax
crypto.SHA1 INPUT
Returns
string
Alias
sha1
{{ sha1 "Hello world" }} → 7b502c3a1f48c8609ae212cdfb639dee39673f5e
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/crypto/SHA1.md)
---
# CSS functions
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
[### css.PostCSS\
\
css.PostCSS \[OPTIONS\] RESOURCE\
\
Processes the given resource with PostCSS using any PostCSS plugin.](https://gohugo.io/functions/css/postcss/)
[### css.Quoted\
\
css.Quoted STRING\
\
Returns the given string, setting its data type to indicate that it must be quoted when used in CSS.](https://gohugo.io/functions/css/quoted/)
[### css.Sass\
\
css.Sass \[OPTIONS\] RESOURCE\
\
Transpiles Sass to CSS.](https://gohugo.io/functions/css/sass/)
[### css.TailwindCSS\
\
css.TailwindCSS \[OPTIONS\] RESOURCE\
\
Processes the given resource with the Tailwind CSS CLI.](https://gohugo.io/functions/css/tailwindcss/)
[### css.Unquoted\
\
css.Unquoted STRING\
\
Returns the given string, setting its data type to indicate that it must not be quoted when used in CSS.](https://gohugo.io/functions/css/unquoted/)
---
# Debug functions
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
[### debug.Dump\
\
debug.Dump VALUE\
\
Returns an object dump as a string.](https://gohugo.io/functions/debug/dump/)
[### debug.Timer\
\
debug.Timer NAME\
\
Creates a named timer that reports elapsed time to the console.](https://gohugo.io/functions/debug/timer/)
[### debug.VisualizeSpaces\
\
debug.VisualizeSpaces STRING\
\
Returns the given string with spaces replaced by a visible string.](https://gohugo.io/functions/debug/visualizespaces/)
---
# BuildDrafts
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Reports reports whether draft publishing is enabled for the current build.
Syntax
SITE.BuildDrafts
Returns
bool
Deprecated in [v0.156.0](https://github.com/gohugoio/hugo/releases/tag/v0.156.0)
See [details](https://discourse.gohugo.io/t/56732)
.
* * *
Last updated: March 2, 2026 : [content: Clean up content for deprecated features (850dc5b2b)](https://github.com/gohugoio/hugoDocs/commit/850dc5b2b26b7136504b24a46d6abede248c0fed)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/site/BuildDrafts.md)
---
# ByLength
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns the given page collection sorted by content length in ascending order.
Syntax
PAGES.ByLength
Returns
page.Pages
{{ range .Pages.ByLength }}
{{ debug.Dump hugo.Data.books }}
[\
{\
"author": "Victor Hugo",\
"rating": 4,\
"title": "The Hunchback of Notre Dame"\
},\
{\
"author": "Victor Hugo",\
"rating": 5,\
"title": "Les Misérables"\
}\
]
Output from this function may change from one release to the next. Use for debugging only.
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/debug/Dump.md)
---
# debug.Timer
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Creates a named timer that reports elapsed time to the console.
Syntax
debug.Timer NAME
Returns
debug.Timer
Use the `debug.Timer` function to determine execution time for a block of code, useful for finding performance bottlenecks in templates.
The timer starts when you instantiate it, and stops when you call its `Stop` method.
{{ $t := debug.Timer "TestSqrt" }}
{{ range 2000 }}
{{ $f := math.Sqrt . }}
{{ end }}
{{ $t.Stop }}
Use the `--logLevel info` command line flag when you build the site.
hugo build --logLevel info
The results are displayed in the console at the end of the build. You can have as many timers as you want and if you don’t stop them, they will be stopped at the end of build.
INFO timer: name TestSqrt count 1002 duration 2.496017496s average 2.491035ms median 2.282291ms
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/debug/Timer.md)
---
# Diagram functions
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
[### diagrams.Goat\
\
diagrams.Goat MARKUP\
\
Returns an SVGDiagram object created from the given GoAT markup and options.](https://gohugo.io/functions/diagrams/goat/)
---
# ByPublishDate
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns the given page collection sorted by publish date in ascending order.
Syntax
PAGES.ByPublishDate
Returns
page.Pages
When sorting by publish date, the value is determined by your [project configuration](https://gohugo.io/configuration/front-matter/#dates)
, defaulting to the `publishDate` field in front matter.
{{ range .Pages.ByPublishDate }}
{{ debug.Dump $taxonomyObject }}
Although the [`Alphabetical`](https://gohugo.io/methods/taxonomy/alphabetical/)
and [`ByCount`](https://gohugo.io/methods/taxonomy/bycount/)
methods provide a better data structure for ranging through the taxonomy, you can render the weighted pages by term directly from the `Taxonomy` object:
{{ range $term, $weightedPages := $taxonomyObject }}
{{ . }}
{{ end }} Is rendered to:foo
baz
See Go’s [`text/template`](https://pkg.go.dev/text/template) documentation for more information. * * * Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/go-template/continue.md) --- # css.Sass Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Transpiles Sass to CSS. Syntax css.Sass \[OPTIONS\] RESOURCE Returns resource.Resource Alias toCSS Transpile Sass to CSS using the LibSass transpiler included in Hugo’s extended and extended/deploy editions, or [install Dart Sass](https://gohugo.io/functions/css/sass/#dart-sass) to use the latest features of the Sass language. The embedded LibSass transpiler was deprecated in [v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0) and will be removed in a future release. Use the Dart Sass transpiler instead. Sass has two forms of syntax: [SCSS](https://sass-lang.com/documentation/syntax#scss) and [indented](https://sass-lang.com/documentation/syntax#the-indented-syntax) . Hugo supports both. Options ------- enableSourceMap (`bool`) Whether to generate a source map. Default is `false`. includePaths (`slice`) A slice of paths, relative to the project root, that the transpiler will use when resolving `@use` and `@import` statements. outputStyle (`string`) The output style of the resulting CSS. With LibSass, one of `nested` (default), `expanded`, `compact`, or `compressed`. With Dart Sass, either `expanded` (default) or `compressed`. precision (`int`) The precision of floating point math. Applicable to LibSass. Default is `8`. silenceDeprecations [New in v0.139.0](https://github.com/gohugoio/hugo/releases/tag/v0.139.0) (`slice`) A slice of deprecation IDs to silence. IDs are enclosed in brackets within Dart Sass warning messages (e.g., `import` in `WARN Dart Sass: DEPRECATED [import]`). Applicable to Dart Sass. Default is `false`. silenceDependencyDeprecations [New in v0.146.0](https://github.com/gohugoio/hugo/releases/tag/v0.146.0) (`bool`) Whether to silence deprecation warnings from dependencies, where a dependency is considered any file transitively imported through a load path. This does not apply to `@warn` or `@debug` rules.Default is `false`. sourceMapIncludeSources (`bool`) Whether to embed sources in the generated source map. Applicable to Dart Sass. Default is `false`. targetPath (`string`) The publish path for the transformed resource, relative to the[`publishDir`](https://gohugo.io/configuration/all/#publishdir) . If unset, the target path defaults to the asset’s original path with a `.css` extension. transpiler (`string`) The transpiler to use, either `libsass` or `dartsass`. Hugo’s extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](https://gohugo.io/functions/css/sass/#dart-sass) . Default is `libsass`. The embedded LibSass transpiler was deprecated in [v0.153.0](https://github.com/gohugoio/hugo/releases/tag/v0.153.0) and will be removed in a future release. Use the Dart Sass transpiler instead. vars (`map`) A map of key-value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/) . // LibSass @import "hugo:vars"; // Dart Sass @use "hugo:vars" as v; When passing a `vars` map to the `css.Sass` function, Hugo detects common typed CSS values such as `24px` or `#FF0000` using regular expression matching. If necessary, you can bypass automatic type inference by using the [`css.Quoted`](https://gohugo.io/functions/css/quoted/) or [`css.Unquoted`](https://gohugo.io/functions/css/unquoted/) function to explicitly indicate a value’s type. Example ------- {{ with resources.Get "sass/main.scss" }} {{ $opts := dict "enableSourceMap" hugo.IsDevelopment "outputStyle" (cond hugo.IsDevelopment "expanded" "compressed") "targetPath" "css/main.css" "transpiler" "dartsass" "vars" site.Params.styles "includePaths" (slice "node_modules/bootstrap/scss") }} {{ with . | toCSS $opts }} {{ if hugo.IsDevelopment }} {{ else }} {{ with . | fingerprint }} {{ end }} {{ end }} {{ end }} {{ end }} Dart Sass --------- Hugo’s extended and extended/deploy editions include [LibSass](https://sass-lang.com/libsass) to transpile Sass to CSS. In 2020, the Sass team deprecated LibSass in favor of [Dart Sass](https://sass-lang.com/dart-sass/) . Use the latest features of the Sass language by installing Dart Sass in your development and production environments. ### Installation overview Dart Sass is compatible with Hugo v0.114.0 and later. If you have been using Embedded Dart Sass[1](https://gohugo.io/functions/css/sass/#fn:1) with Hugo v0.113.0 and earlier, uninstall Embedded Dart Sass, then install Dart Sass. If you have installed both, Hugo will use Dart Sass. If you install Hugo as a [Snap package](https://snapcraft.io/hugo) there is no need to install Dart Sass. The Hugo Snap package includes Dart Sass. ### Installing in a development environment When you install Dart Sass somewhere in your PATH, Hugo will find it. | OS | Package manager | Site | Installation | | --- | --- | --- | --- | | Linux | Homebrew | [brew.sh](https://brew.sh/) | `brew install sass/sass/sass` | | Linux | Snap | [snapcraft.io](https://snapcraft.io/dart-sass) | `sudo snap install dart-sass` | | macOS | Homebrew | [brew.sh](https://brew.sh/) | `brew install sass/sass/sass` | | Windows | Chocolatey | [chocolatey.org](https://community.chocolatey.org/packages/sass) | `choco install sass` | | Windows | Scoop | [scoop.sh](https://scoop.sh/#/apps?q=sass) | `scoop install sass` | You may also install [prebuilt binaries](https://github.com/sass/dart-sass/releases/latest) for Linux, macOS, and Windows. You must install the prebuilt binary outside of your project directory and ensure its path is included in your system’s PATH environment variable. Run `hugo env` to list the active transpilers. If you build Hugo from source and run `mage test -v`, the test will fail if you install Dart Sass as a Snap package. This is due to the Snap package’s strict confinement model. ### Installing in a production environment To use Dart Sass with Hugo on a [CI/CD](https://gohugo.io/quick-reference/glossary/#cicd) platform, you typically must modify your build workflow to install Dart Sass before the Hugo site build begins. This is because these platforms don’t have Dart Sass pre-installed, and Hugo needs it to process your Sass files. There’s one key exception where you can skip this step: you have committed your `resources` directory to your repository. This is only possible if: * You have not changed Hugo’s default asset cache location. * You have not set [`useResourceCacheWhen`](https://gohugo.io/configuration/build/#useresourcecachewhen) to never in your project configuration. By committing the `resources` directory, you’re providing the pre-built CSS files directly to your CI/CD platform, so it doesn’t need to run the Sass compilation itself. For examples of how to install Dart Sass in a production environment, see these hosting guides: * [Cloudflare](https://gohugo.io/host-and-deploy/host-on-cloudflare/) * [GitHub Pages](https://gohugo.io/host-and-deploy/host-on-github-pages/) * [GitLab Pages](https://gohugo.io/host-and-deploy/host-on-gitlab-pages/) * [Netlify](https://gohugo.io/host-and-deploy/host-on-netlify/) * [Render](https://gohugo.io/host-and-deploy/host-on-render/) * [SourceHut](https://gohugo.io/host-and-deploy/host-on-sourcehut-pages/) * [Vercel](https://gohugo.io/host-and-deploy/host-on-vercel/) * * * 1. In 2023, the Sass team deprecated Embedded Dart Sass in favor of Dart Sass. [↩︎](https://gohugo.io/functions/css/sass/#fnref:1) * * * Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/css/Sass.md) --- # Global functions Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  [### page\ \ page\ \ Provides global access to a Page object.](https://gohugo.io/functions/global/page/) [### site\ \ site\ \ Provides global access to the current Site object.](https://gohugo.io/functions/global/site/) --- # Duration methods Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  [### Abs\ \ DURATION.Abs\ \ Returns the absolute value of the given time.Duration value.](https://gohugo.io/methods/duration/abs/) [### Hours\ \ DURATION.Hours\ \ Returns the time.Duration value as a floating point number of hours.](https://gohugo.io/methods/duration/hours/) [### Microseconds\ \ DURATION.Microseconds\ \ Returns the time.Duration value as an integer microsecond count.](https://gohugo.io/methods/duration/microseconds/) [### Milliseconds\ \ DURATION.Milliseconds\ \ Returns the time.Duration value as an integer millisecond count.](https://gohugo.io/methods/duration/milliseconds/) [### Minutes\ \ DURATION.Minutes\ \ Returns the time.Duration value as a floating point number of minutes.](https://gohugo.io/methods/duration/minutes/) [### Nanoseconds\ \ DURATION.Nanoseconds\ \ Returns the time.Duration value as an integer nanosecond count.](https://gohugo.io/methods/duration/nanoseconds/) [### Round\ \ DURATION1.Round DURATION2\ \ Returns the result of rounding DURATION1 to the nearest multiple of DURATION2.](https://gohugo.io/methods/duration/round/) [### Seconds\ \ DURATION.Seconds\ \ Returns the time.Duration value as a floating point number of seconds.](https://gohugo.io/methods/duration/seconds/) [### Truncate\ \ DURATION1.Truncate DURATION2\ \ Returns the result of rounding DURATION1 toward zero to a multiple of DURATION2.](https://gohugo.io/methods/duration/truncate/) --- # collections.Apply Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Returns a slice by transforming each element of the given slice using a specific function and parameters. Syntax collections.Apply SLICE FUNCTION PARAM... Returns \[\]any Alias apply The `apply` function takes three or more arguments, depending on the function being applied to the slice elements. The first argument is the slice itself, the second argument is the function name, and the remaining arguments are passed to the function, with the string `"."` representing the slice element. {{ $s := slice "hello" "world" }} {{ $s = apply $s "strings.FirstUpper" "." }} {{ $s }} → [Hello World] {{ $s = apply $s "strings.Replace" "." "l" "_" }} {{ $s }} → [He__o Wor_d] * * * Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/Apply.md) --- # collections.Append Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Returns a slice by adding one or more elements, or an entire second slice, to the end of the given slice. Syntax collections.Append ELEMENT \[ELEMENT...\] SLICE collections.Append SLICE1 SLICE2 Returns \[\]any Alias append This function appends all elements, excluding the last, to the last element. This allows [pipe](https://gohugo.io/quick-reference/glossary/#pipe) constructs as shown below. Append a single element to a slice: {{ $s := slice "a" "b" }} {{ $s }} → [a b] {{ $s = $s | append "c" }} {{ $s }} → [a b c] Append two elements to a slice: {{ $s := slice "a" "b" }} {{ $s }} → [a b] {{ $s = $s | append "c" "d" }} {{ $s }} → [a b c d] Append two elements, as a slice, to a slice. This produces the same result as the previous example: {{ $s := slice "a" "b" }} {{ $s }} → [a b] {{ $s = $s | append (slice "c" "d") }} {{ $s }} → [a b c d] Start with an empty slice: {{ $s := slice }} {{ $s }} → [] {{ $s = $s | append "a" }} {{ $s }} → [a] {{ $s = $s | append "b" "c" }} {{ $s }} → [a b c] {{ $s = $s | append (slice "d" "e") }} {{ $s }} → [a b c d e] If you start with a slice of a slice: {{ $s := slice (slice "a" "b") }} {{ $s }} → [[a b]] {{ $s = $s | append (slice "c" "d") }} {{ $s }} → [[a b] [c d]] To create a slice of slices, starting with an empty slice: {{ $s := slice }} {{ $s }} → [] {{ $s = $s | append (slice (slice "a" "b")) }} {{ $s }} → [[a b]] {{ $s = $s | append (slice "c" "d") }} {{ $s }} → [[a b] [c d]] Although the elements in the examples above are strings, you can use the `append` function with any data type, including Pages. For example, on the home page of a corporate site, to display links to the two most recent press releases followed by links to the four most recent articles: {{ $p := where site.RegularPages "Type" "press-releases" | first 2 }} {{ $p = $p | append (where site.RegularPages "Type" "articles" | first 4) }} {{ with $p }}{{ .Description }}
{{ end }}{{ .Description }}
This is a bold word.
The showHeroImage parameter is set to {{ site.Params.showHeroImage }}.
{{ end }}
When using the `isset` function you must reference the key using lower case. See the previous example.
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/IsSet.md)
---
# collections.Merge
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a map by combining two or more given maps.
Syntax
collections.Merge MAP MAP...
Returns
map\[string\]any
Alias
merge
Returns the result of merging two or more maps from left to right. If a key already exists, `merge` updates its value. If a key is absent, `merge` inserts the value under the new key.
Key handling is case-insensitive.
The following examples use these map definitions:
{{ $m1 := dict "x" "foo" }}
{{ $m2 := dict "x" "bar" "y" "wibble" }}
{{ $m3 := dict "x" "baz" "y" "wobble" "z" (dict "a" "huey") }}
Example 1
{{ $merged := merge $m1 $m2 $m3 }}
{{ $merged.x }} → baz
{{ $merged.y }} → wobble
{{ $merged.z.a }} → huey
Example 2
{{ $merged := merge $m3 $m2 $m1 }}
{{ $merged.x }} → foo
{{ $merged.y }} → wibble
{{ $merged.z.a }} → huey
Example 3
{{ $merged := merge $m2 $m3 $m1 }}
{{ $merged.x }} → foo
{{ $merged.y }} → wobble
{{ $merged.z.a }} → huey
Example 4
{{ $merged := merge $m1 $m3 $m2 }}
{{ $merged.x }} → bar
{{ $merged.y }} → wibble
{{ $merged.z.a }} → huey
Regardless of depth, merging only applies to maps. For slices, use [append](https://gohugo.io/functions/collections/append/)
.
* * *
Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/Merge.md)
---
# collections.Seq
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a slice of integers starting from 1 or a given value, incrementing by 1 or a given value, and ending at a given value.
Syntax
collections.Seq LAST
collections.Seq FIRST LAST
collections.Seq FIRST INCREMENT LAST
Returns
\[\]int
Alias
seq
{{ seq 2 }} → [1 2]
{{ seq 0 2 }} → [0 1 2]
{{ seq -2 2 }} → [-2 -1 0 1 2]
{{ seq -2 2 2 }} → [-2 0 2]
A contrived example of iterating over a sequence of integers:
{{ $product := 1 }}
{{ range seq 4 }}
{{ $product = mul $product . }}
{{ end }}
{{ $product }} → 24
The slice created by this function is limited to 1 million elements.
* * *
Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/Seq.md)
---
# collections.Last
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns the last N elements of the given slice or string.
Syntax
collections.Last N SLICE|STRING
Returns
any
Alias
last
{{ slice "a" "b" "c" | last 1 }} → [c]
{{ slice "a" "b" "c" | last 2 }} → [b c]
Given that a string is in effect a read-only slice of bytes, this function can be used to return the specified number of bytes from the end of the string:
{{ "abc" | last 1 }} → c
{{ "abc" | last 2 }} → bc
Note that a _character_ may consist of multiple _bytes_:
{{ "Schön" | last 1 }} → n
{{ "Schön" | last 2 }} → \xb6n
{{ "Schön" | last 3 }} → ön
To use the `collections.Last` function with a page collection:
{{ range last 5 .Pages }}
{{ .Render "summary" }}
{{ end }}
Set `N` to zero to return an empty slice:
{{ $emptyPageCollection := last 0 .Pages }}
Use `last` and [`where`](https://gohugo.io/functions/collections/where/)
together:
{{ range where .Pages "Section" "articles" | last 5 }}
{{ .Render "summary" }}
{{ end }}
* * *
Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/Last.md)
---
# collections.SymDiff
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a slice containing the symmetric difference of two given slices.
Syntax
SLICE1 | collections.SymDiff SLICE2
Returns
\[\]any
Alias
symdiff
Example:
{{ slice 1 2 3 | symdiff (slice 3 4) }} → [1 2 4]
Also see [https://en.wikipedia.org/wiki/Symmetric\_difference](https://en.wikipedia.org/wiki/Symmetric_difference)
.
* * *
Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/SymDiff.md)
---
# collections.Querify
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a URL query string from the given map, slice, or sequence of key-value pairs.
Syntax
collections.Querify MAP|SLICE|KEY VALUE...
Returns
string
Alias
querify
Specify the key-value pairs as a map, a slice, or a sequence of scalar values. For example, the following are equivalent:
{{ collections.Querify (dict "a" 1 "b" 2) }}
{{ collections.Querify (slice "a" 1 "b" 2) }}
{{ collections.Querify "a" 1 "b" 2 }}
To append a query string to a URL:
{{ $qs := collections.Querify (dict "a" 1 "b" 2) }}
{{ $href := printf "https://example.org?%s" $qs }}
Link
Hugo renders this to:
Link
You can also pass in a map from your project configuration or front matter. For example:
---
params:
query:
a: 1
b: 2
title: Example
---
+++
title = 'Example'
[params]
[params.query]
a = 1
b = 2
+++
{
"params": {
"query": {
"a": 1,
"b": 2
}
},
"title": "Example"
}
{{ collections.Querify .Params.query }}
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/collections/Querify.md)
---
# Content
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns the content of the given resource.
Syntax
RESOURCE.Content
Returns
any
Use this method with [global resources](https://gohugo.io/quick-reference/glossary/#global-resource)
, [page resources](https://gohugo.io/quick-reference/glossary/#page-resource)
, or [remote resources](https://gohugo.io/quick-reference/glossary/#remote-resource)
.
The `Content` method on a `Resource` object returns `template.HTML` when the [resource type](https://gohugo.io/methods/resource/resourcetype/)
is `page`, otherwise it returns a `string`.
assets/quotations/kipling.txt
He travels the fastest who travels alone.
To get the content:
{{ with resources.Get "quotations/kipling.txt" }}
{{ .Content }} → He travels the fastest who travels alone.
{{ end }}
To get the size in bytes:
{{ with resources.Get "quotations/kipling.txt" }}
{{ .Content | len }} → 42
{{ end }}
To create an inline image:
{{ with resources.Get "images/a.jpg" }}
{{ end }}
To create inline CSS:
{{ with resources.Get "css/style.css" }}
{{ end }}
To create inline JavaScript:
{{ with resources.Get "js/script.js" }}
{{ end }}
* * *
Last updated: August 23, 2025 : [Merge commit 'bfa74537929f409fca841540b971125b7678963a' (6c911d1e5)](https://github.com/gohugoio/hugoDocs/commit/6c911d1e52fb9c8065c079820327f4b0e37529d4)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/resource/Content.md)
---
# Fingerprint
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Cryptographically hash the content of the given resource.
See the [`resources.Fingerprint`](https://gohugo.io/functions/resources/fingerprint/)
function.
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/hugo-pipes/fingerprint.md)
---
# fmt.Warnf
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Log a WARNING from a template.
Syntax
fmt.Warnf FORMAT \[INPUT\]
Returns
string
Alias
warnf
The documentation for Go’s [fmt](https://pkg.go.dev/fmt)
package describes the structure and content of the format string.
The `warnf` function evaluates the format string, then prints the result to the WARNING log. Hugo prints each unique message once to avoid flooding the log with duplicate warnings.
{{ warnf "The %q shortcode was unable to find %s. See %s" .Name $file .Position }}
Use the [`warnidf`](https://gohugo.io/functions/fmt/warnidf/)
function to allow optional suppression of specific warnings.
To prevent suppression of duplicate messages when using `warnf` for debugging, make each message unique with the [`math.Counter`](https://gohugo.io/functions/math/counter/)
function. For example:
{{ range site.RegularPages }}
{{ .Section | warnf "%#[2]v [%[1]d]" math.Counter }}
{{ end }}
* * *
Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/fmt/Warnf.md)
---
# fmt.Warnidf
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Log a suppressible WARNING from a template.
Syntax
fmt.Warnidf ID FORMAT \[INPUT\]
Returns
string
Alias
warnidf
The documentation for Go’s [fmt](https://pkg.go.dev/fmt)
package describes the structure and content of the format string.
The `warnidf` function evaluates the format string, then prints the result to the WARNING log. Unlike the [`warnf`](https://gohugo.io/functions/fmt/warnf/)
function, you may suppress warnings logged by the `warnidf` function by adding the message ID to the `ignoreLogs` array in your project configuration.
This template code:
{{ warnidf "warning-42" "You should consider fixing this." }}
Produces this console log:
WARN You should consider fixing this.
You can suppress this warning by adding the following to your project configuration:
ignoreLogs = ['warning-42']
To suppress this message:
ignoreLogs:
- warning-42
ignoreLogs = ['warning-42']
{
"ignoreLogs": [\
"warning-42"\
]
}
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/functions/fmt/Warnidf.md)
---
# Glob patterns
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
A quick reference guide to glob pattern syntax and matching rules for wildcards, character sets, and delimiters, featuring illustrative examples.
A _glob pattern_ is a pattern used to match sets of values. It is a shorthand for specifying multiple targets at once, making it easier to work with groups of data or configurations.
The table below details the supported glob pattern syntax and its matching behavior. Each example illustrates a specific match type, the pattern used, and the expected boolean result when evaluated against a test string.
| Match type | Glob pattern | Test string | Match? |
| --- | --- | --- | --- |
| Simple wildcard | `a/*.md` | `a/page.md` | true |
| Literal match | `'a/*.md'` | `a/*.md` | true |
| Single-level wildcard | `a/*/page.md` | `a/b/page.md` | true |
| Single-level wildcard | `a/*/page.md` | `a/b/c/page.md` | false |
| Multi-level wildcard | `a/**/page.md` | `a/b/c/page.md` | true |
| Single character | `file.???` | `file.txt` | true |
| Single character | `file.???` | `file.js` | false |
| Delimiter exclusion | `?at` | `f/at` | false |
| Character list | `f.[jt]xt` | `f.txt` | true |
| Negated list | `f.[!j]xt` | `f.txt` | true |
| Character range | `f.[a-c].txt` | `f.b.txt` | true |
| Character range | `f.[a-c].txt` | `f.z.txt` | false |
| Negated range | `f.[!a-c].txt` | `f.z.txt` | true |
| Pattern alternates | `*.{jpg,png}` | `logo.png` | true |
| No match | `*.{jpg,png}` | `logo.webp` | false |
The matching logic follows these rules:
* Standard wildcard (`*`) matches any character except for a delimiter.
* Super wildcard (`**`) matches any character including delimiters.
* Single character (`?`) matches exactly one character, excluding delimiters.
* Negation (`!`) matches any character except those specified in a list or range when used inside brackets.
* Character ranges (`[a-z]`) match any single character within the specified range.
The delimiter is a slash (`/`), except when matching semantic version strings, where the delimiter is a dot (`.`).
* * *
Last updated: February 14, 2026 : [Merge commit '8f3c066d23f431fb2c53d97ea489e4c28b42bd82' (3e2f98235)](https://github.com/gohugoio/hugoDocs/commit/3e2f9823554f16b7b5a9a815b30c9c1fdbc7281b)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/quick-reference/glob-patterns.md)
---
# Comments
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Hugo ships with an internal Disqus template, but this isn’t the only commenting system that will work with your new Hugo website.
Hugo ships with support for [Disqus](https://disqus.com/)
, a third-party service that provides comment and community capabilities to websites via JavaScript.
Your theme may already support Disqus, but if not, it is easy to add to your templates via [Hugo’s built-in Disqus partial](https://gohugo.io/templates/embedded/#disqus)
.
Add Disqus
----------
Hugo comes with all the code you need to load Disqus into your templates. Before adding Disqus to your site, you’ll need to [set up an account](https://disqus.com/profile/signup/)
.
### Configure Disqus
Disqus comments require you set a single value in your [project configuration](https://gohugo.io/configuration/)
:
services:
disqus:
shortname: your-disqus-shortname
[services]
[services.disqus]
shortname = 'your-disqus-shortname'
{
"services": {
"disqus": {
"shortname": "your-disqus-shortname"
}
}
}
For many websites, this is enough configuration. However, you also have the option to set the following in the [front matter](https://gohugo.io/content-management/front-matter/)
of a single content file:
* `disqus_identifier`
* `disqus_title`
* `disqus_url`
### Render Hugo’s built-in Disqus partial template
Disqus has its own [internal template](https://gohugo.io/templates/embedded/#disqus)
available, to render it add the following code where you want comments to appear:
{{ partial "disqus.html" . }}
Alternatives
------------
Commercial commenting systems:
* [Commentix](https://www.commentix.com/)
* [Emote](https://emote.com/)
* [Graph Comment](https://graphcomment.com/)
* [Hyvor Talk](https://talk.hyvor.com/)
* [IntenseDebate](https://intensedebate.com/)
* [ReplyBox](https://getreplybox.com/)
Open-source commenting systems:
* [Cactus Comments](https://cactus.chat/docs/integrations/hugo/)
* [Comentario](https://gitlab.com/comentario/comentario/)
* [Comma](https://github.com/Dieterbe/comma/)
* [Commento](https://commento.io/)
* [Discourse](https://meta.discourse.org/t/embed-discourse-comments-on-another-website-via-javascript/31963)
* [Giscus](https://giscus.app/)
* [Isso](https://isso-comments.de/)
* [Remark42](https://remark42.com/)
* [Staticman](https://staticman.net/)
* [Talkyard](https://blog-comments.talkyard.io/)
* [Utterances](https://utteranc.es/)
* [Zoomment](https://zoomment.com/)
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/content-management/comments.md)
---
# Configure cascade
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Configure cascade.
You can configure your site to cascade front matter values to the home page and any of its descendants. However, this cascading will be prevented if the descendant already defines the field, or if a closer ancestor [node](https://gohugo.io/quick-reference/glossary/#node)
has already cascaded a value for the same field through its front matter’s `cascade` key.
You can also configure cascading behavior within a page’s front matter. See [details](https://gohugo.io/content-management/front-matter/#cascade-1)
.
For example, to cascade a “color” parameter to the home page and all its descendants:
cascade:
params:
color: red
[cascade]
[cascade.params]
color = 'red'
{
"cascade": {
"params": {
"color": "red"
}
}
}
Target
------
The `target`[1](https://gohugo.io/configuration/cascade/#fn:1)
keyword allows you to target specific pages or [environments](https://gohugo.io/quick-reference/glossary/#environment)
. For example, to cascade a “color” parameter to pages within the “articles” section, including the “articles” section page itself:
cascade:
params:
color: red
target:
path: '{/articles,/articles/**}'
[cascade]
[cascade.params]
color = 'red'
[cascade.target]
path = '{/articles,/articles/**}'
{
"cascade": {
"params": {
"color": "red"
},
"target": {
"path": "{/articles,/articles/**}"
}
}
}
Use any combination of these keywords to target pages and/or environments:
environment
(`string`) A [glob pattern](https://gohugo.io/quick-reference/glossary/#glob-pattern)
matching the build [environment](https://gohugo.io/quick-reference/glossary/#environment)
. For example: `{staging,production}`.
kind
(`string`) A [glob pattern](https://gohugo.io/quick-reference/glossary/#glob-pattern)
matching the [page kind](https://gohugo.io/quick-reference/glossary/#page-kind)
. For example: `{taxonomy,term}`.
lang
(`string`) A [glob pattern](https://gohugo.io/quick-reference/glossary/#glob-pattern)
matching the [page language](https://gohugo.io/methods/page/language/)
. For example: `{en,de}`.
path
(`string`) A [glob pattern](https://gohugo.io/quick-reference/glossary/#glob-pattern)
matching the page’s [logical path](https://gohugo.io/quick-reference/glossary/#logical-path)
. For example: `{/books,/books/**}`.
Array
-----
Define an array of cascade parameters to apply different values to different targets. For example:
cascade:
- params:
color: red
target:
kind: page
lang: '{en,de}'
path: /books/**
- params:
color: blue
target:
environment: production
kind: page
path: /films/**
[[cascade]]
[cascade.params]
color = 'red'
[cascade.target]
kind = 'page'
lang = '{en,de}'
path = '/books/**'
[[cascade]]
[cascade.params]
color = 'blue'
[cascade.target]
environment = 'production'
kind = 'page'
path = '/films/**'
{
"cascade": [\
{\
"params": {\
"color": "red"\
},\
"target": {\
"kind": "page",\
"lang": "{en,de}",\
"path": "/books/**"\
}\
},\
{\
"params": {\
"color": "blue"\
},\
"target": {\
"environment": "production",\
"kind": "page",\
"path": "/films/**"\
}\
}\
]
}
* * *
1. The `_target` alias for `target` is deprecated and will be removed in a future release. [↩︎](https://gohugo.io/configuration/cascade/#fnref:1)
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/configuration/cascade.md)
---
# collections.Shuffle
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a slice by randomizing the element order of the given slice.
Syntax
collections.Shuffle SLICE
Returns
\[\]any
Alias
shuffle
{{ collections.Shuffle (slice "a" "b" "c") }} → [b a c]
The result will vary from one build to the next.
To render an unordered list of 5 random pages from a page collection:
Zion National Park
{{ debug.Dump $taxonomyObject }}
Although the [`Alphabetical`](https://gohugo.io/methods/taxonomy/alphabetical/)
and [`ByCount`](https://gohugo.io/methods/taxonomy/bycount/)
methods provide a better data structure for ranging through the taxonomy, you can render the weighted pages by term directly from the `Taxonomy` object:
{{ range $term, $weightedPages := $taxonomyObject }}
{{ debug.Dump $weightedPages }}
Example
-------
With this template:
{{ $weightedPages := $taxonomyObject.Get "suspense" }}
{{ range $weightedPages }}
| Color | Relative luminance |
|---|---|
| {{ .ColorHex }} | {{ .Luminance | lang.FormatNumber 4 }} |
This is light text on a dark background.
| {{ . }} | {{ end }}
|---|
| {{ . }} | {{ end }}
Author: {{ .Params.author }}
ISBN: {{ .Params.isbn }}
Rating: {{ .Params.rating }}
Review date: {{ .Date | time.Format ":date_long" }}
Tags:
{{ .Key }}
{{ .Key }}
{{ .Key | title }}
{{ .Key | title }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Key }}
{{ .Inner | htmlEscape | safeHTML }}
{{ .Page.Store.Set "hasMermaid" true }}
Then include this snippet at the _bottom_ of your base template, before the closing `body` tag:
layouts/baseof.html
{{ if .Store.Get "hasMermaid" }}
{{ end }}
With that you can use the `mermaid` language in Markdown code blocks:
```mermaid
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts Tags
{{ debug.Dump .Fragments.Headings }}
### HeadingsMap
(`map`) A nested map of all headings on the page. Each map contains the following keys: `ID`, `Level`, `Title` and `Headings`. To inspect the data structure:
{{ debug.Dump .Fragments.HeadingsMap }}
### Identifiers
(`slice`) A slice containing the `id` attribute of each heading on the page. If so configured, will also contain the `id` attribute of each description term (i.e., `dt` element) on the page.
See [configure Markup](https://gohugo.io/configuration/markup/#parserautodefinitiontermid)
.
To inspect the data structure:
{{ debug.Dump .Fragments.Identifiers }}
### Identifiers.Contains ID
(`bool`) Reports whether one or more headings on the page has the given `id` attribute, useful for validating fragments within a link [render hook](https://gohugo.io/quick-reference/glossary/#render-hook)
.
{{ .Fragments.Identifiers.Contains "section-2" }} → true
### Identifiers.Count ID
(`int`) The number of headings on a page with the given `id` attribute, useful for detecting duplicates.
{{ .Fragments.Identifiers.Count "section-2" }} → 1
### ToHTML
(`template.HTML`) Returns a TOC as a nested list, either ordered or unordered, identical to the HTML returned by the [`TableOfContents`](https://gohugo.io/methods/page/tableofcontents/)
method. This method take three arguments: the start level (`int`), the end level (`int`), and a boolean (`true` to return an ordered list, `false` to return an unordered list).
Use this method when you want to control the start level, end level, or list type independently from the table of contents settings in your project configuration.
{{ $startLevel := 2 }}
{{ $endLevel := 3 }}
{{ $ordered := true }}
{{ .Fragments.ToHTML $startLevel $endLevel $ordered }}
Hugo renders this to:
It is safe to use the `Fragments` methods within a render hook, even for the current page.
When using the `Fragments` methods within a shortcode, call the shortcode using [standard notation](https://gohugo.io/content-management/shortcodes/#notation)
. If you use [Markdown notation](https://gohugo.io/content-management/shortcodes/#notation)
the rendered shortcode is included in the creation of the fragments map, resulting in a circular loop.
* * *
Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57)
[Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/page/Fragments.md)
---
# GetTerms
Menu
Search
[GitHub 87080 stars](https://github.com/gohugoio/hugo)
[Mastodon](https://fosstodon.org/@gohugoio)
Hugo Documentation
Returns a collection of term pages for terms defined on the given page in the given taxonomy, ordered according to the sequence in which they appear in front matter.
Syntax
PAGE.GetTerms TAXONOMY
Returns
page.Pages
Given this front matter:
---
tags:
- historical
- classic
- fiction
title: Les Misérables
---
+++
tags = ['historical', 'classic', 'fiction']
title = 'Les Misérables'
+++
{
"tags": [\
"historical",\
"classic",\
"fiction"\
],
"title": "Les Misérables"
}
This template code:
{{ with .GetTerms "tags" }}
Tags
Tags
* * * Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/page/GetTerms.md) --- # GetPage Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Returns a Page object from the given path. Syntax PAGE.GetPage PATH Returns page.Page The `GetPage` method is also available on a `Site` object. See [details](https://gohugo.io/methods/site/getpage/) . When using the `GetPage` method on the `Page` object, specify a path relative to the current directory or relative to the `content` directory. If Hugo cannot resolve the path to a page, the method returns nil. If the path is ambiguous, Hugo throws an error and fails the build. Consider this content structure: content/ ├── works/ │ ├── paintings/ │ │ ├── _index.md │ │ ├── starry-night.md │ │ └── the-mona-lisa.md │ ├── sculptures/ │ │ ├── _index.md │ │ ├── david.md │ │ └── the-thinker.md │ └── _index.md └── _index.md The examples below depict the result of rendering `works/paintings/the-mona-lisa.md`: layouts/works/page.html {{ with .GetPage "starry-night" }} {{ .Title }} → Starry Night {{ end }} {{ with .GetPage "./starry-night" }} {{ .Title }} → Starry Night {{ end }} {{ with .GetPage "../paintings/starry-night" }} {{ .Title }} → Starry Night {{ end }} {{ with .GetPage "/works/paintings/starry-night" }} {{ .Title }} → Starry Night {{ end }} {{ with .GetPage "../sculptures/david" }} {{ .Title }} → David {{ end }} {{ with .GetPage "/works/sculptures/david" }} {{ .Title }} → David {{ end }} * * * Last updated: July 7, 2025 : [Merge commit 'bb147f91ee9078e6a55e8c32ab4b2e5dbc5cee45' (079671b41)](https://github.com/gohugoio/hugoDocs/commit/079671b41b9395f2c2b48879f14d3f09d69a63dc) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/page/GetPage.md) --- # GitInfo Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Provides access to commit metadata for a given page. Syntax PAGE.GitInfo Returns \*gitmap.GitInfo The `GitInfo` method on a `Page` object provides access to commit metadata from your Git history, such as the author’s name, the commit hash, and the commit message. Hugo’s Git integration is performant, but may increase build times for large projects. Prerequisites ------------- Install Git, create a repository, and commit your project files. You must also allow Hugo to access your repository by adding this to your project configuration: enableGitInfo: true enableGitInfo = true { "enableGitInfo": true } When you set [`enableGitInfo`](https://gohugo.io/configuration/all/#enablegitinfo) to `true`, the last modification date for each content page will automatically be the Author Date of the last commit for that file. This is configurable. See [details](https://gohugo.io/configuration/front-matter/#dates) . Scope ----- Commit metadata is available for content stored in your local repository and for content provided by [modules](https://gohugo.io/quick-reference/glossary/#module) . ### Local content Hugo retrieves commit metadata for files tracked within your project’s local repository. This includes all content files managed by Git in your main project directory. ### Module content [New in v0.157.0](https://github.com/gohugoio/hugo/releases/tag/v0.157.0) Hugo also retrieves commit metadata for content provided by modules. This allows you to display commit data for remote repositories that are mounted as content directories, such as when aggregating documentation from multiple sources. Methods ------- ### AbbreviatedHash (`string`) Returns the seven-character shortened version of the commit hash. {{ with .GitInfo }} {{ .AbbreviatedHash }} → aab9ec0 {{ end }} ### AuthorDate (`time.Time`) Returns the date the author originally created the commit. {{ with .GitInfo }} {{ .AuthorDate.Format "2006-01-02" }} → 2023-10-09 {{ end }} ### AuthorEmail (`string`) Returns the author’s email address, respecting [gitmailmap](https://git-scm.com/docs/gitmailmap) . {{ with .GitInfo }} {{ .AuthorEmail }} → jsmith@example.org {{ end }} ### AuthorName (`string`) Returns the author’s name, respecting [gitmailmap](https://git-scm.com/docs/gitmailmap) . {{ with .GitInfo }} {{ .AuthorName }} → John Smith {{ end }} ### CommitDate (`time.Time`) Returns the date the commit was applied to the branch. {{ with .GitInfo }} {{ .CommitDate.Format "2006-01-02" }} → 2023-10-09 {{ end }} ### Hash (`string`) Returns the full SHA-1 commit hash. {{ with .GitInfo }} {{ .Hash }} → aab9ec0b31ebac916a1468c4c9c305f2bebf78d4 {{ end }} ### Subject (`string`) Returns the first line of the commit message (the summary). {{ with .GitInfo }} {{ .Subject }} → Add tutorials {{ end }} ### Body (`string`) Returns the full content of the commit message, excluding the subject line. {{ with .GitInfo }} {{ .Body }} → Two new pages added. {{ end }} ### Ancestors (`gitmap.GitInfos`) Returns a list of previous commits for this specific file, ordered from most recent to oldest. For example, to list the last 5 commits: {{ with .GitInfo }} {{ range .Ancestors | first 5 }} {{ .CommitDate.Format "2006-01-02" }}: {{ .Subject }} {{ end }} {{ end }} To reverse the order: {{ with .GitInfo }} {{ range .Ancestors.Reverse | first 5 }} {{ .CommitDate.Format "2006-01-02" }}: {{ .Subject }} {{ end }} {{ end }} ### Parent (`*gitmap.GitInfo`) Returns the most recent ancestor commit for the file, if any. Last modified date ------------------ By default, when `enableGitInfo` is `true`, the `Lastmod` method on a `Page` object returns the Git AuthorDate of the last commit that included the file. You can change this behavior in your [project configuration](https://gohugo.io/configuration/front-matter/) . Hosting considerations ---------------------- On a [CI/CD](https://gohugo.io/quick-reference/glossary/#cicd) platform, the step that clones your project repository must perform a deep clone. If the clone is shallow, the Git information for a given file may be inaccurate. It might incorrectly reflect the most recent repository commit, rather than the commit that actually modified the file. While some providers perform a deep clone by default, others require you to configure the depth yourself. | Hosting service | Default clone depth | Configurable | | --- | --- | --- | | AWS Amplify | Deep | N/A | | Cloudflare | Shallow | Yes [1](https://gohugo.io/methods/page/gitinfo/#fn:1) | | DigitalOcean App Platform | Deep | N/A | | GitHub Pages | Shallow | Yes [2](https://gohugo.io/methods/page/gitinfo/#fn:2) | | GitLab Pages | Shallow | Yes [3](https://gohugo.io/methods/page/gitinfo/#fn:3) | | Netlify | Deep | N/A | | Render | Shallow | Yes [1](https://gohugo.io/methods/page/gitinfo/#fn:1) | | Vercel | Shallow | Yes [1](https://gohugo.io/methods/page/gitinfo/#fn:1) | * * * 1. To perform a deep clone when hosting on Cloudflare, Render, or Vercel, include this code in the build script after the repository has been cloned: if [ "$(git rev-parse --is-shallow-repository)" = "true" ]; then git fetch --unshallow fi [↩︎](https://gohugo.io/methods/page/gitinfo/#fnref:1) [↩︎](https://gohugo.io/methods/page/gitinfo/#fnref1:1) [↩︎](https://gohugo.io/methods/page/gitinfo/#fnref2:1) 2. To perform a deep clone when hosting on GitHub Pages, set `fetch-depth: 0` in the `checkout` step of the GitHub Action. See [example](https://gohugo.io/host-and-deploy/host-on-github-pages/#step-7) . [↩︎](https://gohugo.io/methods/page/gitinfo/#fnref:2) 3. To perform a deep clone when hosting on GitLab Pages, set the `GIT_DEPTH` environment variable to `0` in the workflow file. See [example](https://gohugo.io/host-and-deploy/host-on-gitlab-pages/#configure-gitlab-cicd) . [↩︎](https://gohugo.io/methods/page/gitinfo/#fnref:3) * * * Last updated: February 27, 2026 : [content: Miscellaneous udpates for v0.157.0 (35da1aa3c)](https://github.com/gohugoio/hugoDocs/commit/35da1aa3c2fe3b54bdb57df1a308533844af9df5) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/page/GitInfo.md) --- # HasMenuCurrent Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  Reports whether the given Page object matches the Page object associated with one of the child menu entries under the given menu entry in the given menu. Syntax PAGE.HasMenuCurrent MENU MENUENTRY Returns bool If the `Page` object associated with the menu entry is a section, this method also returns `true` for any descendant of that section. {{ $currentPage := . }} {{ range site.Menus.main }} {{ if $currentPage.IsMenuCurrent .Menu . }} {{ .Name }} {{ else if $currentPage.HasMenuCurrent .Menu . }} {{ .Name }} {{ else }} {{ .Name }} {{ end }} {{ end }} See [menu templates](https://gohugo.io/templates/menu/#example) for a complete example. When using this method you must either define the menu entry in front matter, or specify a `pageRef` property when defining the menu entry in your project configuration. * * * Last updated: February 25, 2026 : [Merge commit '0c2fa2460f485e0eca564dcccf36d34538374922' (b0d3364f1)](https://github.com/gohugoio/hugoDocs/commit/b0d3364f14192a13e95a5d30e9e3af1febb0bf57) [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/methods/page/HasMenuCurrent.md) --- # Functions Menu Search [GitHub 87080 stars](https://github.com/gohugoio/hugo) [Mastodon](https://fosstodon.org/@gohugoio) Hugo Documentation  A quick reference guide to Hugo’s functions, grouped by namespace. Aliases, if any, appear in parentheses to the right of the function name. cast ---- Use these functions to cast a value from one data type to another. [cast.ToFloat](https://gohugo.io/functions/cast/tofloat/) Converts a value to a decimal floating-point number (base 10). [cast.ToInt](https://gohugo.io/functions/cast/toint/) Converts a value to a decimal integer (base 10). [cast.ToString](https://gohugo.io/functions/cast/tostring/) Converts a value to a string. collections ----------- Use these functions to manipulate and query maps, slices, and strings. [collections.After](https://gohugo.io/functions/collections/after/) Returns a slice containing the elements after the first N elements of the given slice. [collections.Append](https://gohugo.io/functions/collections/append/) Returns a slice by adding one or more elements, or an entire second slice, to the end of the given slice. [collections.Apply](https://gohugo.io/functions/collections/apply/) Returns a slice by transforming each element of the given slice using a specific function and parameters. [collections.Complement](https://gohugo.io/functions/collections/complement/) Returns a slice by identifying elements in the last given slice that do not appear in any of the preceding slices. [collections.D](https://gohugo.io/functions/collections/d/) Returns a sorted slice of unique random integers based on a given seed, count, and maximum value. [collections.Delimit](https://gohugo.io/functions/collections/delimit/) Returns a string by joining the values of the given slice or map with a delimiter. [collections.Dictionary](https://gohugo.io/functions/collections/dictionary/) Returns a map created from the given key-value pairs. [collections.First](https://gohugo.io/functions/collections/first/) Returns the first N elements of the given slice or string. [collections.Group](https://gohugo.io/functions/collections/group/) Returns a map by grouping the given page collection (slice) by a specific key. [collections.In](https://gohugo.io/functions/collections/in/) Reports whether a value exists within the given slice or string. [collections.Index](https://gohugo.io/functions/collections/indexfunction/) Returns an element or value from the given slice or map at the specified key(s). [collections.Intersect](https://gohugo.io/functions/collections/intersect/) Returns a slice containing the common elements found in two given slices, in the same order as the first slice. [collections.IsSet](https://gohugo.io/functions/collections/isset/) Reports whether a specific key or index exists in the given map or slice. [collections.KeyVals](https://gohugo.io/functions/collections/keyvals/) Returns a KeyVals struct by pairing a given key and values. [collections.Last](https://gohugo.io/functions/collections/last/) Returns the last N elements of the given slice or string. [collections.Merge](https://gohugo.io/functions/collections/merge/) Returns a map by combining two or more given maps. [collections.NewScratch](https://gohugo.io/functions/collections/newscratch/) Returns a locally scoped "scratch pad" to store and manipulate data. [collections.Querify](https://gohugo.io/functions/collections/querify/) Returns a URL query string from the given map, slice, or sequence of key-value pairs. [collections.Reverse](https://gohugo.io/functions/collections/reverse/) Returns a slice by reversing the order of elements in the given slice. [collections.Seq](https://gohugo.io/functions/collections/seq/) Returns a slice of integers starting from 1 or a given value, incrementing by 1 or a given value, and ending at a given value. [collections.Shuffle](https://gohugo.io/functions/collections/shuffle/) Returns a slice by randomizing the element order of the given slice. [collections.Slice](https://gohugo.io/functions/collections/slice/) Returns a slice created from the given values. [collections.Sort](https://gohugo.io/functions/collections/sort/) Returns a sorted map or slice by reordering the given collection by a key and order. [collections.SymDiff](https://gohugo.io/functions/collections/symdiff/) Returns a slice containing the symmetric difference of two given slices. [collections.Union](https://gohugo.io/functions/collections/union/) Returns a slice containing the unique elements from two given slices. [collections.Uniq](https://gohugo.io/functions/collections/uniq/) Returns a slice by removing duplicate elements from the given slice. [collections.Where](https://gohugo.io/functions/collections/where/) Returns a slice by filtering the given slice based on a key, operator, and value. compare ------- Use these functions to compare two or more values. [compare.Conditional](https://gohugo.io/functions/compare/conditional/) Returns one of two arguments depending on the value of the control argument. [compare.Default](https://gohugo.io/functions/compare/default/) Returns the second argument if set, else the first argument. [compare.Eq](https://gohugo.io/functions/compare/eq/) Returns the boolean truth of arg1 == arg2 || arg1 == arg3. [compare.Ge](https://gohugo.io/functions/compare/ge/) Returns the boolean truth of arg1 >= arg2 && arg1 >= arg3. [compare.Gt](https://gohugo.io/functions/compare/gt/) Returns the boolean truth of arg1 > arg2 && arg1 > arg3. [compare.Le](https://gohugo.io/functions/compare/le/) Returns the boolean truth of arg1 <= arg2 && arg1 <= arg3. [compare.Lt](https://gohugo.io/functions/compare/lt/) Returns the boolean truth of arg1 < arg2 && arg1 < arg3. [compare.Ne](https://gohugo.io/functions/compare/ne/) Returns the boolean truth of arg1 != arg2 && arg1 != arg3. crypto ------ Use these functions to create cryptographic hashes. [crypto.FNV32a](https://gohugo.io/functions/crypto/fnv32a/) Returns the 32-bit FNV (Fowler-Noll-Vo) non-cryptographic hash of the given string. [crypto.HMAC](https://gohugo.io/functions/crypto/hmac/) Returns a cryptographic hash that uses a key to sign a message. [crypto.MD5](https://gohugo.io/functions/crypto/md5/) Hashes the given input and returns its MD5 checksum encoded to a hexadecimal string. [crypto.SHA1](https://gohugo.io/functions/crypto/sha1/) Hashes the given input and returns its SHA1 checksum encoded to a hexadecimal string. [crypto.SHA256](https://gohugo.io/functions/crypto/sha256/) Hashes the given input and returns its SHA256 checksum encoded to a hexadecimal string. css --- Use these functions to work with CSS and Sass files. [css.PostCSS](https://gohugo.io/functions/css/postcss/) Processes the given resource with PostCSS using any PostCSS plugin. [css.Quoted](https://gohugo.io/functions/css/quoted/) Returns the given string, setting its data type to indicate that it must be quoted when used in CSS. [css.Sass](https://gohugo.io/functions/css/sass/) Transpiles Sass to CSS. [css.TailwindCSS](https://gohugo.io/functions/css/tailwindcss/) Processes the given resource with the Tailwind CSS CLI. [css.Unquoted](https://gohugo.io/functions/css/unquoted/) Returns the given string, setting its data type to indicate that it must not be quoted when used in CSS. debug ----- Use these functions to debug your templates. [debug.Dump](https://gohugo.io/functions/debug/dump/) Returns an object dump as a string. [debug.Timer](https://gohugo.io/functions/debug/timer/) Creates a named timer that reports elapsed time to the console. [debug.VisualizeSpaces](https://gohugo.io/functions/debug/visualizespaces/) Returns the given string with spaces replaced by a visible string. diagrams -------- Use these functions to render diagrams. [diagrams.Goat](https://gohugo.io/functions/diagrams/goat/) Returns an SVGDiagram object created from the given GoAT markup and options. encoding -------- Use these functions to encode and decode data. [encoding.Base64Decode](https://gohugo.io/functions/encoding/base64decode/) Returns the base64 decoding of the given content. [encoding.Base64Encode](https://gohugo.io/functions/encoding/base64encode/) Returns the base64 decoding of the given content. [encoding.Jsonify](https://gohugo.io/functions/encoding/jsonify/) Encodes the given object to JSON. fmt --- Use these functions to print strings within a template or to print messages to the terminal. [fmt.Errorf](https://gohugo.io/functions/fmt/errorf/) Log an ERROR from a template. [fmt.Erroridf](https://gohugo.io/functions/fmt/erroridf/) Log a suppressible ERROR from a template. [fmt.Print](https://gohugo.io/functions/fmt/print/) Prints the default representation of the given arguments using the standard `fmt.Print` function. [fmt.Printf](https://gohugo.io/functions/fmt/printf/) Formats a string using the standard `fmt.Sprintf` function. [fmt.Println](https://gohugo.io/functions/fmt/println/) Prints the default representation of the given argument using the standard `fmt.Print` function and enforces a line break. [fmt.Warnf](https://gohugo.io/functions/fmt/warnf/) Log a WARNING from a template. [fmt.Warnidf](https://gohugo.io/functions/fmt/warnidf/) Log a suppressible WARNING from a template. global ------ Use these global functions to access page and site data. [page](https://gohugo.io/functions/global/page/) Provides global access to a Page object. [site](https://gohugo.io/functions/global/site/) Provides global access to the current Site object. go template ----------- These are the functions, operators, and statements provided by Go's text/template package. [and](https://gohugo.io/functions/go-template/and/) Returns the first falsy argument. If all arguments are truthy, returns the last argument. [block](https://gohugo.io/functions/go-template/block/) Defines a template and executes it in place. [break](https://gohugo.io/functions/go-template/break/) Used with the range statement, stops the innermost iteration and bypasses all remaining iterations. [continue](https://gohugo.io/functions/go-template/continue/) Used with the range statement, stops the innermost iteration and continues to the next iteration. [define](https://gohugo.io/functions/go-template/define/) Defines a template. [else](https://gohugo.io/functions/go-template/else/) Begins an alternate block for if, with, and range statements. [end](https://gohugo.io/functions/go-template/end/) Terminates if, with, range, block, and define statements. [if](https://gohugo.io/functions/go-template/if/) Executes the block if the expression is truthy. [len](https://gohugo.io/functions/go-template/len/) Returns the length of a string, slice, map, or collection. [not](https://gohugo.io/functions/go-template/not/) Returns the boolean negation of its single argument. [or](https://gohugo.io/functions/go-template/or/) Returns the first truthy argument. If all arguments are falsy, returns the last argument. [range](https://gohugo.io/functions/go-template/range/) Iterates over a non-empty collection, binds context (the dot) to successive elements, and executes the block. [return](https://gohugo.io/functions/go-template/return/) Used within partial templates, terminates template execution and returns the given value, if any. [template](https://gohugo.io/functions/go-template/template/) Executes the given template, optionally passing context. [try](https://gohugo.io/functions/go-template/try/) Returns a TryValue object after evaluating the given expression. [urlquery](https://gohugo.io/functions/go-template/urlquery/) Returns the escaped value of the textual representation of its arguments in a form suitable for embedding in a URL query. [with](https://gohugo.io/functions/go-template/with/) Binds context (the dot) to the expression and executes the block if expression is truthy. hash ---- Use these functions to create non-cryptographic hashes. [hash.FNV32a](https://gohugo.io/functions/hash/fnv32a/) Returns the 32-bit FNV (Fowler-Noll-Vo) non-cryptographic hash of the given string. [hash.XxHash](https://gohugo.io/functions/hash/xxhash/) Returns the 64-bit xxHash non-cryptographic hash of the given string. hugo ---- Use these functions to access information about the Hugo application and the current environment. [hugo.BuildDate](https://gohugo.io/functions/hugo/builddate/) Returns the compile date of the Hugo binary. [hugo.CommitHash](https://gohugo.io/functions/hugo/commithash/) Returns the Git commit hash of the Hugo binary. [hugo.Data](https://gohugo.io/functions/hugo/data/) Returns a data structure composed from the files in the data directory. [hugo.Deps](https://gohugo.io/functions/hugo/deps/) Returns a slice of project dependencies, either Hugo Modules or local theme components. [hugo.Environment](https://gohugo.io/functions/hugo/environment/) Returns the current running environment. [hugo.Generator](https://gohugo.io/functions/hugo/generator/) Renders an HTML meta element identifying the software that generated the site. [hugo.GoVersion](https://gohugo.io/functions/hugo/goversion/) Returns the Go version used to compile the Hugo binary [hugo.IsDevelopment](https://gohugo.io/functions/hugo/isdevelopment/) Reports whether the current running environment is "development". [hugo.IsExtended](https://gohugo.io/functions/hugo/isextended/) Reports whether the Hugo binary is either the extended or extended/deploy edition. [hugo.IsMultihost](https://gohugo.io/functions/hugo/ismultihost/) Reports whether each configured language has a unique base URL. [hugo.IsMultilingual](https://gohugo.io/functions/hugo/ismultilingual/) Reports whether there are two or more configured languages. [hugo.IsProduction](https://gohugo.io/functions/hugo/isproduction/) Reports whether the current running environment is "production". [hugo.IsServer](https://gohugo.io/functions/hugo/isserver/) Reports whether the built-in development server is running. [hugo.Sites](https://gohugo.io/functions/hugo/sites/) Returns a collection of all sites for all dimensions. [hugo.Store](https://gohugo.io/functions/hugo/store/) Returns a globally scoped "scratch pad" to store and manipulate data. [hugo.Version](https://gohugo.io/functions/hugo/version/) Returns the current version of the Hugo binary. [hugo.WorkingDir](https://gohugo.io/functions/hugo/workingdir/) Returns the project working directory. images ------ Use these functions to create an image filter, apply an image filter to an image, and to retrieve image information. [images.AutoOrient](https://gohugo.io/functions/images/autoorient/) Returns an image filter that rotates and flips an image as needed per its Exif orientation tag. [images.Brightness](https://gohugo.io/functions/images/brightness/) Returns an image filter that changes the brightness of an image. [images.ColorBalance](https://gohugo.io/functions/images/colorbalance/) Returns an image filter that changes the color balance of an image. [images.Colorize](https://gohugo.io/functions/images/colorize/) Returns an image filter that produces a colorized version of an image. [images.Config](https://gohugo.io/functions/images/config/) Returns an image.Config structure from the image at the specified path, relative to the working directory. [images.Contrast](https://gohugo.io/functions/images/contrast/) Returns an image filter that changes the contrast of an image. [images.Dither](https://gohugo.io/functions/images/dither/) Returns an image filter that dithers an image. [images.Filter](https://gohugo.io/functions/images/filter/) Applies one or more image filters to the given image resource. [images.Gamma](https://gohugo.io/functions/images/gamma/) Returns an image filter that performs gamma correction on an image. [images.GaussianBlur](https://gohugo.io/functions/images/gaussianblur/) Returns an image filter that applies a gaussian blur to an image. [images.Grayscale](https://gohugo.io/functions/images/grayscale/) Returns an image filter that produces a grayscale version of an image. [images.Hue](https://gohugo.io/functions/images/hue/) Returns an image filter that rotates the hue of an image. [images.Invert](https://gohugo.io/functions/images/invert/) Returns an image filter that negates the colors of an image. [images.Mask](https://gohugo.io/functions/images/mask/) Returns an image filter that applies a mask to the source image. [images.Opacity](https://gohugo.io/functions/images/opacity/) Returns an image filter that changes the opacity of an image. [images.Overlay](https://gohugo.io/functions/images/overlay/) Returns an image filter that overlays the source image at the given coordinates, relative to the upper left corner. [images.Padding](https://gohugo.io/functions/images/padding/) Returns an image filter that resizes the image canvas without resizing the image. [images.Pixelate](https://gohugo.io/functions/images/pixelate/) Returns an image filter that applies a pixelation effect to an image. [images.Process](https://gohugo.io/functions/images/process/) Returns an image filter that processes an image according to the given processing specification. [images.QR](https://gohugo.io/functions/images/qr/) Encodes the given text into a QR code using the specified options, returning an image resource. [images.Saturation](https://gohugo.io/functions/images/saturation/) Returns an image filter that changes the saturation of an image. [images.Sepia](https://gohugo.io/functions/images/sepia/) Returns an image filter that produces a sepia-toned version of an image. [images.Sigmoid](https://gohugo.io/functions/images/sigmoid/) Returns an image filter that changes the contrast of an image using a sigmoidal function. [images.Text](https://gohugo.io/functions/images/text/) Returns an image filter that adds text to an image. [images.UnsharpMask](https://gohugo.io/functions/images/unsharpmask/) Returns an image filter that sharpens an image. inflect ------- These functions provide word inflection features such as singularization and pluralization of English nouns. [inflect.Humanize](https://gohugo.io/functions/inflect/humanize/) Returns the humanized version of the input with the first letter capitalized. [inflect.Pluralize](https://gohugo.io/functions/inflect/pluralize/) Pluralizes the given word according to a set of common English pluralization rules. [inflect.Singularize](https://gohugo.io/functions/inflect/singularize/) Singularizes the given word according to a set of common English singularization rules. js -- Use these functions to work with JavaScript and TypeScript files. [js.Babel](https://gohugo.io/functions/js/babel/) Compile the given JavaScript resource with Babel. [js.Batch](https://gohugo.io/functions/js/batch/) Build JavaScript bundle groups with global code splitting and flexible hooks/runners setup. [js.Build](https://gohugo.io/functions/js/build/) Bundle, transpile, tree shake, and minify JavaScript resources. lang ---- Use these functions to adapt your site to meet language and regional requirements. [lang.FormatAccounting](https://gohugo.io/functions/lang/formataccounting/) Returns a currency representation of a number for the given currency and precision for the current language and region in accounting notation. [lang.FormatCurrency](https://gohugo.io/functions/lang/formatcurrency/) Returns a currency representation of a number for the given currency and precision for the current language and region. [lang.FormatNumber](https://gohugo.io/functions/lang/formatnumber/) Returns a numeric representation of a number with the given precision for the current language and region. [lang.FormatNumberCustom](https://gohugo.io/functions/lang/formatnumbercustom/) Returns a numeric representation of a number with the given precision using negative, decimal, and grouping options. [lang.FormatPercent](https://gohugo.io/functions/lang/formatpercent/) Returns a percentage representation of a number with the given precision for the current language and region. [lang.Merge](https://gohugo.io/functions/lang/merge/) Merge missing translations from other languages. [lang.Translate](https://gohugo.io/functions/lang/translate/) Translates a string using the translation tables in the i18n directory. math ---- Use these functions to perform mathematical operations. [math.Abs](https://gohugo.io/functions/math/abs/) Returns the absolute value of the given number. [math.Acos](https://gohugo.io/functions/math/acos/) Returns the arccosine, in radians, of the given number. [math.Add](https://gohugo.io/functions/math/add/) Adds two or more numbers. [math.Asin](https://gohugo.io/functions/math/asin/) Returns the arcsine, in radians, of the given number. [math.Atan](https://gohugo.io/functions/math/atan/) Returns the arctangent, in radians, of the given number. [math.Atan2](https://gohugo.io/functions/math/atan2/) Returns the arctangent, in radians, of the given number pair, determining the correct quadrant from their signs. [math.Ceil](https://gohugo.io/functions/math/ceil/) Returns the least integer value greater than or equal to the given number. [math.Cos](https://gohugo.io/functions/math/cos/) Returns the cosine of the given radian number. [math.Counter](https://gohugo.io/functions/math/counter/) Increments and returns a global counter. [math.Div](https://gohugo.io/functions/math/div/) Divides the first number by one or more numbers. [math.Floor](https://gohugo.io/functions/math/floor/) Returns the greatest integer value less than or equal to the given number. [math.Log](https://gohugo.io/functions/math/log/) Returns the natural logarithm of the given number. [math.Max](https://gohugo.io/functions/math/max/) Returns the greater of all numbers. Accepts scalars, slices, or both. [math.MaxInt64](https://gohugo.io/functions/math/maxint64/) Returns the maximum value for a signed 64-bit integer. [math.Min](https://gohugo.io/functions/math/min/) Returns the smaller of all numbers. Accepts scalars, slices, or both. [math.Mod](https://gohugo.io/functions/math/mod/) Returns the modulus of two integers. [math.ModBool](https://gohugo.io/functions/math/modbool/) Reports whether the modulus of two integers equals 0. [math.Mul](https://gohugo.io/functions/math/mul/) Multiplies two or more numbers. [math.Pi](https://gohugo.io/functions/math/pi/) Returns the mathematical constant pi. [math.Pow](https://gohugo.io/functions/math/pow/) Returns the first number raised to the power of the second number. [math.Product](https://gohugo.io/functions/math/product/) Returns the product of all numbers. Accepts scalars, slices, or both. [math.Rand](https://gohugo.io/functions/math/rand/) Returns a pseudo-random number in the half-open interval \[0.0, 1.0).\ \ [math.Round](https://gohugo.io/functions/math/round/)\ \ Returns the nearest integer, rounding half away from zero.\ \ [math.Sin](https://gohugo.io/functions/math/sin/)\ \ Returns the sine of the given radian number.\ \ [math.Sqrt](https://gohugo.io/functions/math/sqrt/)\ \ Returns the square root of the given number.\ \ [math.Sub](https://gohugo.io/functions/math/sub/)\ \ Subtracts one or more numbers from the first number.\ \ [math.Sum](https://gohugo.io/functions/math/sum/)\ \ Returns the sum of all numbers. Accepts scalars, slices, or both.\ \ [math.Tan](https://gohugo.io/functions/math/tan/)\ \ Returns the tangent of the given radian number.\ \ [math.ToDegrees](https://gohugo.io/functions/math/todegrees/)\ \ ToDegrees converts radians into degrees.\ \ [math.ToRadians](https://gohugo.io/functions/math/toradians/)\ \ ToRadians converts degrees into radians.\ \ openapi3\ --------\ \ Use these functions to work with OpenAPI 3 definitions.\ \ [openapi3.Unmarshal](https://gohugo.io/functions/openapi3/unmarshal/)\ \ Unmarshals the given resource into an OpenAPI 3 Description.\ \ os\ --\ \ Use these functions to interact with the operating system.\ \ [os.FileExists](https://gohugo.io/functions/os/fileexists/)\ \ Reports whether the file or directory exists.\ \ [os.Getenv](https://gohugo.io/functions/os/getenv/)\ \ Returns the value of an environment variable, or an empty string if the environment variable is not set.\ \ [os.ReadDir](https://gohugo.io/functions/os/readdir/)\ \ Returns an array of FileInfo structures sorted by file name, one element for each directory entry.\ \ [os.ReadFile](https://gohugo.io/functions/os/readfile/)\ \ Returns the contents of a file.\ \ [os.Stat](https://gohugo.io/functions/os/stat/)\ \ Returns a FileInfo structure describing a file or directory.\ \ partials\ --------\ \ Use these functions to call partial templates.\ \ [partials.Include](https://gohugo.io/functions/partials/include/)\ \ Executes the given template, optionally passing context. If the partial template contains a return statement, returns the given value, else returns the rendered output.\ \ [partials.IncludeCached](https://gohugo.io/functions/partials/includecached/)\ \ Executes the given template and caches the result, optionally passing one or more variant keys. If the partial template contains a return statement, returns the given value, else returns the rendered output.\ \ path\ ----\ \ Use these functions to work with file paths.\ \ [path.Base](https://gohugo.io/functions/path/base/)\ \ Replaces path separators with slashes (`/`) and returns the last element of the given path.\ \ [path.BaseName](https://gohugo.io/functions/path/basename/)\ \ Replaces path separators with slashes (`/`) and returns the last element of the given path, removing the extension if present.\ \ [path.Clean](https://gohugo.io/functions/path/clean/)\ \ Replaces path separators with slashes (`/`) and returns the shortest path name equivalent to the given path.\ \ [path.Dir](https://gohugo.io/functions/path/dir/)\ \ Replaces path separators with slashes (/) and returns all but the last element of the given path.\ \ [path.Ext](https://gohugo.io/functions/path/ext/)\ \ Replaces path separators with slashes (`/`) and returns the file name extension of the given path.\ \ [path.Join](https://gohugo.io/functions/path/join/)\ \ Replaces path separators with slashes (`/`), joins the given path elements into a single path, and returns the shortest path name equivalent to the result.\ \ [path.Split](https://gohugo.io/functions/path/split/)\ \ Replaces path separators with slashes (`/`) and splits the resulting path immediately following the final slash, separating it into a directory and file name component.\ \ reflect\ -------\ \ Use these functions to determine a value's data type.\ \ [reflect.IsImageResource](https://gohugo.io/functions/reflect/isimageresource/)\ \ Reports whether the given value is a Resource object representing an image as defined by its media type.\ \ [reflect.IsImageResourceProcessable](https://gohugo.io/functions/reflect/isimageresourceprocessable/)\ \ Reports whether the given value is a Resource object representing an image from which Hugo can extract dimensions and perform processing such as converting, resizing, cropping, or filtering.\ \ [reflect.IsImageResourceWithMeta](https://gohugo.io/functions/reflect/isimageresourcewithmeta/)\ \ Reports whether the given value is a Resource object representing an image from which Hugo can extract dimensions and, if present, Exif, IPTC, and XMP data.\ \ [reflect.IsMap](https://gohugo.io/functions/reflect/ismap/)\ \ Reports whether the given value is a map.\ \ [reflect.IsPage](https://gohugo.io/functions/reflect/ispage/)\ \ Reports whether the given value is a Page object.\ \ [reflect.IsResource](https://gohugo.io/functions/reflect/isresource/)\ \ Reports whether the given value is a Resource object.\ \ [reflect.IsSite](https://gohugo.io/functions/reflect/issite/)\ \ Reports whether the given value is a Site object.\ \ [reflect.IsSlice](https://gohugo.io/functions/reflect/isslice/)\ \ Reports whether the given value is a slice.\ \ resources\ ---------\ \ Use these functions to work with resources.\ \ [resources.Babel](https://gohugo.io/functions/resources/babel/)\ \ Compiles the given JavaScript resource with Babel.\ \ [resources.ByType](https://gohugo.io/functions/resources/bytype/)\ \ Returns a collection of global resources of the given media type, or nil if none found.\ \ [resources.Concat](https://gohugo.io/functions/resources/concat/)\ \ Returns a concatenated slice of resources.\ \ [resources.Copy](https://gohugo.io/functions/resources/copy/)\ \ Copies the given resource to the target path.\ \ [resources.ExecuteAsTemplate](https://gohugo.io/functions/resources/executeastemplate/)\ \ Returns a resource created from a Go template, parsed and executed with the given context.\ \ [resources.Fingerprint](https://gohugo.io/functions/resources/fingerprint/)\ \ Cryptographically hashes the content of the given resource.\ \ [resources.FromString](https://gohugo.io/functions/resources/fromstring/)\ \ Returns a resource created from a string.\ \ [resources.Get](https://gohugo.io/functions/resources/get/)\ \ Returns a global resource from the given path, or nil if none found.\ \ [resources.GetMatch](https://gohugo.io/functions/resources/getmatch/)\ \ Returns the first global resource from paths matching the given glob pattern, or nil if none found.\ \ [resources.GetRemote](https://gohugo.io/functions/resources/getremote/)\ \ Returns a remote resource from the given URL, or nil if none found.\ \ [resources.Match](https://gohugo.io/functions/resources/match/)\ \ Returns a collection of global resources from paths matching the given glob pattern, or nil if none found.\ \ [resources.Minify](https://gohugo.io/functions/resources/minify/)\ \ Minifies the given resource.\ \ [resources.PostCSS](https://gohugo.io/functions/resources/postcss/)\ \ Processes the given resource with PostCSS using any PostCSS plugin.\ \ [resources.PostProcess](https://gohugo.io/functions/resources/postprocess/)\ \ Processes the given resource after the build.\ \ [resources.ToCSS](https://gohugo.io/functions/resources/tocss/)\ \ Transpiles Sass to CSS.\ \ safe\ ----\ \ Use these functions to declare a value as safe in the context of Go's html/template package.\ \ [safe.CSS](https://gohugo.io/functions/safe/css/)\ \ Declares the given string as a safe CSS string.\ \ [safe.HTML](https://gohugo.io/functions/safe/html/)\ \ Declares the given string as a safeHTML string.\ \ [safe.HTMLAttr](https://gohugo.io/functions/safe/htmlattr/)\ \ Declares the given key-value pair as a safe HTML attribute.\ \ [safe.JS](https://gohugo.io/functions/safe/js/)\ \ Declares the given string as a safe JavaScript expression.\ \ [safe.JSStr](https://gohugo.io/functions/safe/jsstr/)\ \ Declares the given string as a safe JavaScript string.\ \ [safe.URL](https://gohugo.io/functions/safe/url/)\ \ Declares the given string as a safe URL or URL substring.\ \ strings\ -------\ \ Use these functions to work with strings.\ \ [strings.Chomp](https://gohugo.io/functions/strings/chomp/)\ \ Returns the given string, removing all trailing newline characters and carriage returns.\ \ [strings.Contains](https://gohugo.io/functions/strings/contains/)\ \ Reports whether the given string contains the given substring.\ \ [strings.ContainsAny](https://gohugo.io/functions/strings/containsany/)\ \ Reports whether the given string contains any character within the given set.\ \ [strings.ContainsNonSpace](https://gohugo.io/functions/strings/containsnonspace/)\ \ Reports whether the given string contains any non-space characters as defined by Unicode.\ \ [strings.Count](https://gohugo.io/functions/strings/count/)\ \ Returns the number of non-overlapping instances of the given substring within the given string.\ \ [strings.CountRunes](https://gohugo.io/functions/strings/countrunes/)\ \ Returns the number of runes in the given string excluding whitespace.\ \ [strings.CountWords](https://gohugo.io/functions/strings/countwords/)\ \ Returns the number of words in the given string.\ \ [strings.Diff](https://gohugo.io/functions/strings/diff/)\ \ Returns an anchored diff of the two texts OLD and NEW in the unified diff format. If OLD and NEW are identical, returns an empty string.\ \ [strings.FindRE](https://gohugo.io/functions/strings/findre/)\ \ Returns a slice of strings that match the regular expression.\ \ [strings.FindRESubmatch](https://gohugo.io/functions/strings/findresubmatch/)\ \ Returns a slice of all successive matches of the regular expression. Each element is a slice of strings holding the text of the leftmost match of the regular expression and the matches, if any, of its subexpressions.\ \ [strings.FirstUpper](https://gohugo.io/functions/strings/firstupper/)\ \ Returns the given string, capitalizing the first character.\ \ [strings.HasPrefix](https://gohugo.io/functions/strings/hasprefix/)\ \ Reports whether the given string begins with the given prefix.\ \ [strings.HasSuffix](https://gohugo.io/functions/strings/hassuffix/)\ \ Reports whether the given string ends with the given suffix.\ \ [strings.Repeat](https://gohugo.io/functions/strings/repeat/)\ \ Returns a new string consisting of zero or more copies of another string.\ \ [strings.Replace](https://gohugo.io/functions/strings/replace/)\ \ Returns a copy of INPUT, replacing all occurrences of OLD with NEW.\ \ [strings.ReplaceRE](https://gohugo.io/functions/strings/replacere/)\ \ Returns a copy of INPUT, replacing all occurrences of a regular expression with a replacement pattern.\ \ [strings.RuneCount](https://gohugo.io/functions/strings/runecount/)\ \ Returns the number of runes in the given string.\ \ [strings.SliceString](https://gohugo.io/functions/strings/slicestring/)\ \ Returns a substring of the given string, beginning with the start position and ending before the end position.\ \ [strings.Split](https://gohugo.io/functions/strings/split/)\ \ Returns a slice of strings by splitting the given string by a delimiter.\ \ [strings.Substr](https://gohugo.io/functions/strings/substr/)\ \ Returns a substring of the given string, beginning with the start position and ending after the given length.\ \ [strings.Title](https://gohugo.io/functions/strings/title/)\ \ Returns the given string, converting it to title case.\ \ [strings.ToLower](https://gohugo.io/functions/strings/tolower/)\ \ Returns the given string, converting all characters to lowercase.\ \ [strings.ToUpper](https://gohugo.io/functions/strings/toupper/)\ \ Returns the given string, converting all characters to uppercase.\ \ [strings.Trim](https://gohugo.io/functions/strings/trim/)\ \ Returns the given string, removing leading and trailing characters specified in the cutset.\ \ [strings.TrimLeft](https://gohugo.io/functions/strings/trimleft/)\ \ Returns the given string, removing leading characters specified in the cutset.\ \ [strings.TrimPrefix](https://gohugo.io/functions/strings/trimprefix/)\ \ Returns the given string, removing the prefix from the beginning of the string.\ \ [strings.TrimRight](https://gohugo.io/functions/strings/trimright/)\ \ Returns the given string, removing trailing characters specified in the cutset.\ \ [strings.TrimSpace](https://gohugo.io/functions/strings/trimspace/)\ \ Returns the given string, removing leading and trailing whitespace as defined by Unicode.\ \ [strings.TrimSuffix](https://gohugo.io/functions/strings/trimsuffix/)\ \ Returns the given string, removing the suffix from the end of the string.\ \ [strings.Truncate](https://gohugo.io/functions/strings/truncate/)\ \ Returns the given string, truncating it to a maximum length without cutting words or leaving unclosed HTML tags.\ \ templates\ ---------\ \ Use these functions to query the template system.\ \ [templates.Current](https://gohugo.io/functions/templates/current/)\ \ Returns information about the currently executing template.\ \ [templates.Defer](https://gohugo.io/functions/templates/defer/)\ \ Defer execution of a template until after all sites and output formats have been rendered.\ \ [templates.Exists](https://gohugo.io/functions/templates/exists/)\ \ Reports whether a template file exists under the given path relative to the layouts directory.\ \ [templates.Inner](https://gohugo.io/functions/templates/inner/)\ \ Executes the content block enclosed by a partial call.\ \ time\ ----\ \ Use these functions to work with time values.\ \ [time.AsTime](https://gohugo.io/functions/time/astime/)\ \ Returns the given string representation of a date/time value as a time.Time value.\ \ [time.Duration](https://gohugo.io/functions/time/duration/)\ \ Returns a time.Duration value using the given time unit and number.\ \ [time.Format](https://gohugo.io/functions/time/format/)\ \ Returns the given date/time as a formatted and localized string.\ \ [time.In](https://gohugo.io/functions/time/in/)\ \ Returns the given date/time as represented in the specified IANA time zone.\ \ [time.Now](https://gohugo.io/functions/time/now/)\ \ Returns the current local time.\ \ [time.ParseDuration](https://gohugo.io/functions/time/parseduration/)\ \ Returns a time.Duration value by parsing the given duration string.\ \ transform\ ---------\ \ Use these functions to transform values from one format to another.\ \ [transform.CanHighlight](https://gohugo.io/functions/transform/canhighlight/)\ \ Reports whether the given code language is supported by the Chroma highlighter.\ \ [transform.Emojify](https://gohugo.io/functions/transform/emojify/)\ \ Runs a string through the Emoji emoticons processor.\ \ [transform.Highlight](https://gohugo.io/functions/transform/highlight/)\ \ Renders code with a syntax highlighter.\ \ [transform.HighlightCodeBlock](https://gohugo.io/functions/transform/highlightcodeblock/)\ \ Highlights code received in context within a code block render hook.\ \ [transform.HTMLEscape](https://gohugo.io/functions/transform/htmlescape/)\ \ Returns the given string, escaping special characters by replacing them with HTML entities.\ \ [transform.HTMLToMarkdown](https://gohugo.io/functions/transform/htmltomarkdown/)\ \ Converts HTML to Markdown.\ \ [transform.HTMLUnescape](https://gohugo.io/functions/transform/htmlunescape/)\ \ Returns the given string, replacing each HTML entity with its corresponding character.\ \ [transform.Markdownify](https://gohugo.io/functions/transform/markdownify/)\ \ Renders Markdown to HTML.\ \ [transform.Plainify](https://gohugo.io/functions/transform/plainify/)\ \ Returns a string with all HTML tags removed.\ \ [transform.PortableText](https://gohugo.io/functions/transform/portabletext/)\ \ Converts Portable Text to Markdown.\ \ [transform.Remarshal](https://gohugo.io/functions/transform/remarshal/)\ \ Marshals a string of serialized data, or a map, into a string of serialized data in the specified format.\ \ [transform.ToMath](https://gohugo.io/functions/transform/tomath/)\ \ Renders mathematical equations and expressions written in the LaTeX markup language.\ \ [transform.Unmarshal](https://gohugo.io/functions/transform/unmarshal/)\ \ Parses serialized data and returns a map or an array. Supports CSV, JSON, TOML, YAML, and XML.\ \ [transform.XMLEscape](https://gohugo.io/functions/transform/xmlescape/)\ \ Returns the given string, removing disallowed characters then escaping the result to its XML equivalent.\ \ urls\ ----\ \ Use these functions to work with URLs.\ \ [urls.AbsLangURL](https://gohugo.io/functions/urls/abslangurl/)\ \ Returns an absolute URL with a language prefix, if any.\ \ [urls.AbsURL](https://gohugo.io/functions/urls/absurl/)\ \ Returns an absolute URL.\ \ [urls.Anchorize](https://gohugo.io/functions/urls/anchorize/)\ \ Returns the given string, sanitized for usage in an HTML id attribute.\ \ [urls.JoinPath](https://gohugo.io/functions/urls/joinpath/)\ \ Joins the provided elements into a URL string and cleans the result of any ./ or ../ elements. If the argument list is empty, JoinPath returns an empty string.\ \ [urls.Parse](https://gohugo.io/functions/urls/parse/)\ \ Parses a URL into a URL structure.\ \ [urls.PathEscape](https://gohugo.io/functions/urls/pathescape/)\ \ Returns the given string, applying percent-encoding to special characters and reserved delimiters so it can be safely used as a segment within a URL path.\ \ [urls.PathUnescape](https://gohugo.io/functions/urls/pathunescape/)\ \ Returns the given string, replacing all percent-encoded sequences with the corresponding unescaped characters.\ \ [urls.Ref](https://gohugo.io/functions/urls/ref/)\ \ Returns the absolute URL of the page with the given path, language, and output format.\ \ [urls.RelLangURL](https://gohugo.io/functions/urls/rellangurl/)\ \ Returns a relative URL with a language prefix, if any.\ \ [urls.RelRef](https://gohugo.io/functions/urls/relref/)\ \ Returns the relative URL of the page with the given path, language, and output format.\ \ [urls.RelURL](https://gohugo.io/functions/urls/relurl/)\ \ Returns a relative URL.\ \ [urls.URLize](https://gohugo.io/functions/urls/urlize/)\ \ Returns the given string, sanitized for usage in a URL.\ \ * * *\ \ Last updated: April 10, 2025 : [Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65' (283e97783)](https://github.com/gohugoio/hugoDocs/commit/283e9778348774c2282f193fc7cf459e45a5c107)\ \ [Improve this page](https://github.com/gohugoio/hugoDocs/edit/master/content/en/quick-reference/functions.md) ---