diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section-with-title.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section-with-title.html
deleted file mode 100644
index 71a14c0ef..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section-with-title.html
+++ /dev/null
@@ -1,14 +0,0 @@
-{{ if or .PrevInSection .NextInSection }}
-{{/* this div holds these a tags as a unit for flex-box display */}}
-
-{{ end }}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section.html
deleted file mode 100644
index af9f4aac1..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/partials/previous-next-links-in-section.html
+++ /dev/null
@@ -1,16 +0,0 @@
-{{ if or .PrevInSection .NextInSection }}
-{{/* this div holds these a tags as a unit for flex-box display */}}
-
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/gomodules-info.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/gomodules-info.html
deleted file mode 100644
index d544cd471..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/gomodules-info.html
+++ /dev/null
@@ -1,18 +0,0 @@
-{{ $text := `
-Most of the commands for **Hugo Modules** require a newer version (>= 1.18) of Go installed (see https://golang.org/dl/) and the relevant VCS client (e.g. Git, see https://git-scm.com/downloads/ ).
-If you have an "older" site running on Netlify, you may have to set GO_VERSION to 1.19 or newer in your Environment settings.
-
-For more information about Go Modules, see:
-
-* https://go.dev/wiki/Modules
-* https://blog.golang.org/using-go-modules
-` }}
-
-
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/new-in.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/new-in.html
deleted file mode 100644
index 606d2219c..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/new-in.html
+++ /dev/null
@@ -1,34 +0,0 @@
-{{- /*
-Renders a "new in" button indicating the version in which a feature was added.
-
-When comparing the current version to the specified version, the "new in"
-button will be hidden if any of the following conditions is true:
-
-- The major version difference exceeds the majorVersionDiffThreshold
-- The minor version difference exceeds the minorVersionDiffThreshold
-
-@param {string} version The semantic version string, with or without a leading v.
-@returns {template.HTML}
-
-@example {{< new-in 0.100.0 >}}
-*/}}
-
-{{- /* Set defaults. */}}
-{{- $majorVersionDiffThreshold := 0 }}
-{{- $minorVersionDiffThreshold := 30 }}
-{{- $displayExpirationWarning := true }}
-
-{{- /* Render. */}}
-{{- with $version := .Get 0 | strings.TrimPrefix "v" }}
- {{- $majorVersionDiff := sub (index (split hugo.Version ".") 0 | int) (index (split $version ".") 0 | int) }}
- {{- $minorVersionDiff := sub (index (split hugo.Version ".") 1 | int) (index (split $version ".") 1 | int) }}
- {{- if or (gt $majorVersionDiff $majorVersionDiffThreshold) (gt $minorVersionDiff $minorVersionDiffThreshold) }}
- {{- if $displayExpirationWarning }}
- {{- warnf "This call to the %q shortcode should be removed: %s. The button is now hidden because the specified version (%s) is older than the display threshold." $.Name $.Position $version }}
- {{- end }}
- {{- else }}
- New in v{{ $version }}
- {{- end }}
-{{- else }}
- {{- errorf "The %q shortcode requires a positional parameter (version). See %s" .Name .Position }}
-{{- end -}}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/note.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/note.html
deleted file mode 100644
index 99818114e..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/note.html
+++ /dev/null
@@ -1,7 +0,0 @@
-{{ $_hugo_config := `{ "version": 1 }` }}
-
-
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/readfile.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/readfile.html
deleted file mode 100644
index de8083443..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/readfile.html
+++ /dev/null
@@ -1,29 +0,0 @@
-{{- $highlight := or (.Get "highlight") "" }}
-
-{{- $markdown := false }}
-{{- if in (slice "false" false 0) (.Get "markdown") }}
- {{- $markdown = false }}
-{{- else if in (slice "true" true 1) (.Get "markdown") }}
- {{- $markdown = true }}
-{{- end }}
-
-{{- with .Get "file" }}
- {{- if os.FileExists . }}
- {{- with os.ReadFile . }}
- {{- $content := trim . "\n\r" }}
- {{- if $markdown }}
- {{- $content | markdownify }}
- {{- else if $highlight }}
- {{- highlight $content $highlight }}
- {{- else }}
- {{- $content | safeHTML }}
- {{- end }}
- {{- else }}
- {{- errorf "The %q shortcode was unable to read %q. See %s" $.Name . $.Position }}
- {{- end }}
- {{- else }}
- {{- errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
- {{- end }}
-{{- else }}
- {{- errorf "The %q shortcode requires a 'file' parameter. See %s" $.Name $.Position }}
-{{- end }}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/todo.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/todo.html
deleted file mode 100644
index 50a099267..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/todo.html
+++ /dev/null
@@ -1 +0,0 @@
-{{ if .Inner }}{{ end }}
\ No newline at end of file
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/showcase/list.html b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/showcase/list.html
deleted file mode 100644
index bff52ad8d..000000000
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/showcase/list.html
+++ /dev/null
@@ -1,46 +0,0 @@
-{{ define "main" }}
-
-{{ end }}
-
-{{ with $paginator }}
- {{ .PageSize }}
-{{ end }}
-```
diff --git a/content/en/methods/pager/PagerSize.md b/content/en/methods/pager/PagerSize.md
index 623548398..5f5f7d3a8 100644
--- a/content/en/methods/pager/PagerSize.md
+++ b/content/en/methods/pager/PagerSize.md
@@ -10,7 +10,7 @@ action:
signatures: [PAGER.PagerSize]
---
-{{< new-in 0.128.0 >}}
+{{< new-in 0.128.0 />}}
The number of pages per pager is determined by the optional second argument passed to the [`Paginate`] method, falling back to the `pagerSize` as defined in your [site configuration].
diff --git a/content/en/methods/resource/Colors.md b/content/en/methods/resource/Colors.md
index 73fe1e7ae..08f63ae3f 100644
--- a/content/en/methods/resource/Colors.md
+++ b/content/en/methods/resource/Colors.md
@@ -20,11 +20,11 @@ The `Resources.Colors` method returns a slice of the most dominant colors in an
Each color is an object with the following methods:
ColorHex
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`string`) Returns the [hexadecimal color] value, prefixed with a hash sign.
Luminance
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`float64`) Returns the [relative luminance] of the color in the sRGB colorspace in the range [0, 1]. A value of `0` represents the darkest black, while a value of `1` represents the lightest white.
{{% note %}}
diff --git a/content/en/methods/resource/Data.md b/content/en/methods/resource/Data.md
index f62de34d2..b6744d1be 100644
--- a/content/en/methods/resource/Data.md
+++ b/content/en/methods/resource/Data.md
@@ -17,6 +17,7 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
+{{ $opts := dict "responseHeaders" (slice "Server") }}
{{ with try (resources.GetRemote $url) }}
{{ with .Err }}
{{ errorf "%s" . }}
@@ -24,6 +25,7 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
{{ with .Data }}
{{ .ContentLength }} → 42764
{{ .ContentType }} → image/jpeg
+ {{ .Headers }} → map[Server:[Netlify]]
{{ .Status }} → 200 OK
{{ .StatusCode }} → 200
{{ .TransferEncoding }} → []
@@ -34,19 +36,30 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
{{ end }}
```
-ContentLength
-: (`int`) The content length in bytes.
+###### ContentLength
-ContentType
-: (`string`) The content type.
+(`int`) The content length in bytes.
-Status
-: (`string`) The HTTP status text.
+###### ContentType
-StatusCode
-: (`int`) The HTTP status code.
+(`string`) The content type.
-TransferEncoding
-: (`string`) The transfer encoding.
+###### Headers
+
+(`map[string][]string`) A map of response headers matching those requested in the [`responseHeaders`] option passed to the `resources.GetRemote` function. The header name matching is case-insensitive. In most cases there will be one value per header key.
+
+[`responseHeaders`]: /functions/resources/getremote/#responseheaders
+
+###### Status
+
+(`string`) The HTTP status text.
+
+###### StatusCode
+
+(`int`) The HTTP status code.
+
+###### TransferEncoding
+
+(`string`) The transfer encoding.
[`resources.GetRemote`]: /functions/resources/getremote/
diff --git a/content/en/methods/resource/Err.md b/content/en/methods/resource/Err.md
index 776127caf..34ba6f9bc 100644
--- a/content/en/methods/resource/Err.md
+++ b/content/en/methods/resource/Err.md
@@ -9,7 +9,7 @@ action:
- methods/resource/Data
returnType: resource.resourceError
signatures: [RESOURCE.Err]
-expiryDate: 2026-01-16 # deprecated 2025-01-16
+expiryDate: 2027-01-16 # deprecated 2025-01-16 in v0.141.0
---
{{% deprecated-in 0.141.0 %}}
diff --git a/content/en/methods/shortcode/Scratch.md b/content/en/methods/shortcode/Scratch.md
index b044a66c8..6dd882e24 100644
--- a/content/en/methods/shortcode/Scratch.md
+++ b/content/en/methods/shortcode/Scratch.md
@@ -1,14 +1,13 @@
---
title: Scratch
-description: Returns a "scratch pad" scoped to the shortcode to store and manipulate data.
+description: Returns a "scratch pad" to store and manipulate data, scoped to the current shortcode.
categories: []
keywords: []
action:
- related:
- - functions/collections/NewScratch
+ related: []
returnType: maps.Scratch
signatures: [SHORTCODE.Scratch]
-expiryDate: 2025-11-18 # deprecated 2024-11-18
+expiryDate: 2026-11-18 # deprecated 2024-11-18 (soft)
---
{{% deprecated-in 0.139.0 %}}
@@ -20,14 +19,3 @@ Beginning with v0.139.0 the `SHORTCODE.Scratch` method is aliased to `SHORTCODE.
[`SHORTCODE.Store`]: /methods/shortcode/store/
{{% /deprecated-in %}}
-
-The `Scratch` method within a shortcode creates a [scratch pad](g) to store and manipulate data. The scratch pad is scoped to the shortcode.
-
-{{% note %}}
-With the introduction of the [`newScratch`] function, and the ability to [assign values to template variables] after initialization, the `Scratch` method within a shortcode is obsolete.
-
-[assign values to template variables]: https://go.dev/doc/go1.11#text/template
-[`newScratch`]: /functions/collections/newscratch/
-{{% /note %}}
-
-{{% include "methods/page/_common/scratch-methods.md" %}}
diff --git a/content/en/methods/shortcode/Store.md b/content/en/methods/shortcode/Store.md
index 2e6c467ce..8d9a8596b 100644
--- a/content/en/methods/shortcode/Store.md
+++ b/content/en/methods/shortcode/Store.md
@@ -1,21 +1,22 @@
---
title: Store
-description: Returns a "Store pad" scoped to the shortcode to store and manipulate data.
+description: Returns a "scratch pad" to store and manipulate data, scoped to the current shortcode.
categories: []
keywords: []
action:
related:
- - functions/collections/NewScratch
- methods/page/Store
- methods/site/Store
- functions/hugo/Store
- returnType: maps.Store
+ - functions/collections/NewScratch
+ returnType: maps.Scratch
signatures: [SHORTCODE.Store]
+toc: true
---
-{{< new-in 0.139.0 >}}
+{{< new-in 0.139.0 />}}
-The `Store` method within a shortcode creates a [scratch pad](g) to store and manipulate data. The scratch pad is scoped to the shortcode.
+Use the `Store` method to create a [scratch pad](g) to store and manipulate data, scoped to the current shortcode. To create a scratch pad with a different [scope](g), refer to the [scope](#scope) section below.
{{% note %}}
With the introduction of the [`newScratch`] function, and the ability to [assign values to template variables] after initialization, the `Store` method within a shortcode is mostly obsolete.
@@ -24,4 +25,6 @@ With the introduction of the [`newScratch`] function, and the ability to [assign
[`newScratch`]: /functions/collections/newScratch/
{{% /note %}}
-{{% include "methods/page/_common/scratch-methods.md" %}}
+{{% include "_common/store-methods.md" %}}
+
+{{% include "_common/scratch-pad-scope.md" %}}
diff --git a/content/en/methods/shortcode/_index.md b/content/en/methods/shortcode/_index.md
index d26366844..1c99adba7 100644
--- a/content/en/methods/shortcode/_index.md
+++ b/content/en/methods/shortcode/_index.md
@@ -7,6 +7,7 @@ keywords: []
menu:
docs:
parent: methods
+aliases: [/variables/shortcodes]
---
Use these methods in your shortcode templates.
diff --git a/content/en/methods/site/DisqusShortname.md b/content/en/methods/site/DisqusShortname.md
index 0e900ac4e..f6fedf4e9 100644
--- a/content/en/methods/site/DisqusShortname.md
+++ b/content/en/methods/site/DisqusShortname.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: string
signatures: [SITE.DisqusShortname]
-expiryDate: 2024-10-30 # deprecated 2023-10-30
+expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
---
{{% deprecated-in 0.120.0 %}}
diff --git a/content/en/methods/site/GoogleAnalytics.md b/content/en/methods/site/GoogleAnalytics.md
index c58974452..f87e1787e 100644
--- a/content/en/methods/site/GoogleAnalytics.md
+++ b/content/en/methods/site/GoogleAnalytics.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: string
signatures: [SITE.GoogleAnalytics]
-expiryDate: 2024-10-30 # deprecated 2023-10-30
+expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
---
{{% deprecated-in 0.120.0 %}}
diff --git a/content/en/methods/site/IsDevelopment.md b/content/en/methods/site/IsDevelopment.md
index 6f443316b..51783efb9 100644
--- a/content/en/methods/site/IsDevelopment.md
+++ b/content/en/methods/site/IsDevelopment.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: bool
signatures: [SITE.IsDevelopment]
-expiryDate: 2024-10-30 # deprecated 2023-10-30
+expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
---
{{% deprecated-in 0.120.0 %}}
@@ -15,7 +15,3 @@ Use [`hugo.IsDevelopment`] instead.
[`hugo.IsDevelopment`]: /functions/hugo/isdevelopment/
{{% /deprecated-in %}}
-
-```go-html-template
-{{ .Site.IsDevelopment }} → true/false
-```
diff --git a/content/en/methods/site/IsMultiLingual.md b/content/en/methods/site/IsMultiLingual.md
index 7ec938812..10968f14d 100644
--- a/content/en/methods/site/IsMultiLingual.md
+++ b/content/en/methods/site/IsMultiLingual.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: bool
signatures: [SITE.IsMultiLingual]
-expiryDate: 2025-03-16 # deprecated 2024-03-16
+expiryDate: 2026-03-16 # deprecated 2024-03-16 in 0.124.0
---
{{% deprecated-in 0.124.0 %}}
@@ -15,27 +15,3 @@ Use [`hugo.IsMultilingual`] instead.
[`hugo.IsMultilingual`]: /functions/hugo/ismultilingual/
{{% /deprecated-in %}}
-
-Site configuration:
-
-{{< code-toggle file=hugo >}}
-defaultContentLanguage = 'de'
-defaultContentLanguageInSubdir = true
-[languages]
- [languages.de]
- languageCode = 'de-DE'
- languageName = 'Deutsch'
- title = 'Projekt Dokumentation'
- weight = 1
- [languages.en]
- languageCode = 'en-US'
- languageName = 'English'
- title = 'Project Documentation'
- weight = 2
-{{< /code-toggle >}}
-
-Template:
-
-```go-html-template
-{{ .Site.IsMultiLingual }} → true
-```
diff --git a/content/en/methods/site/IsServer.md b/content/en/methods/site/IsServer.md
index a688c553a..8fb5b7bf6 100644
--- a/content/en/methods/site/IsServer.md
+++ b/content/en/methods/site/IsServer.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: bool
signatures: [SITE.IsServer]
-expiryDate: 2024-10-30 # deprecated 2023-10-30
+expiryDate: 2025-10-30 # deprecated 2023-10-30 in v0.120.0
---
{{% deprecated-in 0.120.0 %}}
@@ -15,7 +15,3 @@ Use [`hugo.IsServer`] instead.
[`hugo.IsServer`]: /functions/hugo/isserver/
{{% /deprecated-in %}}
-
-```go-html-template
-{{ .Site.IsServer }} → true/false
-```
diff --git a/content/en/methods/site/LastChange.md b/content/en/methods/site/LastChange.md
index 65925c0eb..f6017df04 100644
--- a/content/en/methods/site/LastChange.md
+++ b/content/en/methods/site/LastChange.md
@@ -7,7 +7,7 @@ action:
related: []
returnType: time.Time
signatures: [SITE.LastChange]
-expiryDate: 2025-02-19 # deprecated 2024-02-19
+expiryDate: 2026-02-19 # deprecated 2024-02-19 in v0.123.0
---
{{% deprecated-in 0.123.0 %}}
@@ -15,14 +15,3 @@ Use [`.Site.Lastmod`] instead.
[`.Site.Lastmod`]: /methods/site/lastmod/
{{% /deprecated-in %}}
-
-The `LastChange` method on a `Site` object returns a [`time.Time`] value. Use this with time [functions] and [methods]. For example:
-
-```go-html-template
-{{ .Site.LastChange | time.Format ":date_long" }} → January 31, 2024
-
-```
-
-[`time.Time`]: https://pkg.go.dev/time#Time
-[functions]: /functions/time/
-[methods]: /methods/time/
diff --git a/content/en/methods/site/Lastmod.md b/content/en/methods/site/Lastmod.md
index 081481956..f1663db49 100644
--- a/content/en/methods/site/Lastmod.md
+++ b/content/en/methods/site/Lastmod.md
@@ -9,7 +9,7 @@ action:
signatures: [SITE.Lastmod]
---
-{{< new-in 0.123.0 >}}
+{{< new-in 0.123.0 />}}
The `Lastmod` method on a `Site` object returns a [`time.Time`] value. Use this with time [functions] and [methods]. For example:
diff --git a/content/en/methods/site/Store.md b/content/en/methods/site/Store.md
index 8a6c5b86e..dcc3a0bed 100644
--- a/content/en/methods/site/Store.md
+++ b/content/en/methods/site/Store.md
@@ -1,7 +1,6 @@
---
title: Store
-linktitle: site.Store
-description: Returns a persistent "scratch pad" on the given site to store and manipulate data.
+description: Returns a "scratch pad" to store and manipulate data, scoped to the current site.
categories: []
keywords: []
action:
@@ -14,12 +13,9 @@ action:
toc: true
---
-{{< new-in 0.139.0 >}}
+{{< new-in 0.139.0 />}}
-The `Store` method on a `Site` object creates a persistent [scratch pad](g) to store and manipulate data. To create a locally scoped scratch pad that is not attached to a `Site` object, use the [`newScratch`] function.
-
-[`Scratch`]: /methods/site/scratch/
-[`newScratch`]: /functions/collections/newscratch/
+Use the `Store` method on a `Site` object to create a [scratch pad](g) to store and manipulate data, scoped to the current site. To create a scratch pad with a different [scope](g), refer to the [scope](#scope) section below.
## Methods
@@ -104,6 +100,8 @@ Removes the given key.
{{ site.Store.Delete "greeting" }}
```
+{{% include "_common/scratch-pad-scope.md" %}}
+
## Determinate values
The `Store` method is often used to set scratch pad values within a shortcode, a partial template called by a shortcode, or by a Markdown render hook. In all three cases, the scratch pad values are indeterminate until Hugo renders the page content.
diff --git a/content/en/methods/taxonomy/Page.md b/content/en/methods/taxonomy/Page.md
index e148ac5c7..039719b93 100644
--- a/content/en/methods/taxonomy/Page.md
+++ b/content/en/methods/taxonomy/Page.md
@@ -9,7 +9,7 @@ action:
signatures: [TAXONOMY.Page]
---
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
This `TAXONOMY` method returns nil if the taxonomy has no terms, so you must code defensively:
diff --git a/content/en/myshowcase/index.md b/content/en/myshowcase/index.md
index 969095d12..abb4ad6b2 100644
--- a/content/en/myshowcase/index.md
+++ b/content/en/myshowcase/index.md
@@ -2,6 +2,7 @@
title: Myshowcase
date: 2021-01-14
+draft: true
description: "A short description of this page."
diff --git a/content/en/news/_index.md b/content/en/news/_index.md
index a1959bd1d..c170a69a4 100644
--- a/content/en/news/_index.md
+++ b/content/en/news/_index.md
@@ -1,7 +1,9 @@
---
title: News
+description: Stay up-to-date with the latest news and announcements.
outputs:
- html
- rss
aliases: [/release-notes/]
+weight: 10
---
diff --git a/content/en/quick-reference/_index.md b/content/en/quick-reference/_index.md
index b5f434e2d..f2673ba37 100644
--- a/content/en/quick-reference/_index.md
+++ b/content/en/quick-reference/_index.md
@@ -1,7 +1,7 @@
---
title: Quick reference guides
-linkTitle: In this section
-description: Quick reference guides to Hugo's features, functions, and methods.
+linktitle: Quick reference
+description: Use these quick reference guides for quick access to key information.
categories: []
keywords: []
menu:
@@ -13,4 +13,4 @@ weight: 10
showSectionMenu: false
---
-Quick reference guides to Hugo's features, functions, and methods.
+{{% param description %}}
diff --git a/content/en/getting-started/glossary/_index.md b/content/en/quick-reference/glossary/_index.md
similarity index 58%
rename from content/en/getting-started/glossary/_index.md
rename to content/en/quick-reference/glossary/_index.md
index 001d80fe0..1b5111e8e 100644
--- a/content/en/getting-started/glossary/_index.md
+++ b/content/en/quick-reference/glossary/_index.md
@@ -1,13 +1,15 @@
---
-title: Glossary of terms
+title: Glossary
description: Terms commonly used throughout the documentation.
-categories: [getting started]
+categories: [quick-reference]
keywords: [glossary]
+hide_in_this_section: true
menu:
docs:
- parent: getting-started
- weight: 80
-weight: 80
+ parent: quick-reference
+ weight: 40
+aliases: [/getting-started/glossary/]
+weight: 40
layout: single
build:
render: always
diff --git a/content/en/quick-reference/glossary/action.md b/content/en/quick-reference/glossary/action.md
new file mode 100644
index 000000000..ced877327
--- /dev/null
+++ b/content/en/quick-reference/glossary/action.md
@@ -0,0 +1,5 @@
+---
+title: action
+---
+
+See [_template action_](g).
diff --git a/content/en/quick-reference/glossary/archetype.md b/content/en/quick-reference/glossary/archetype.md
new file mode 100644
index 000000000..231089c56
--- /dev/null
+++ b/content/en/quick-reference/glossary/archetype.md
@@ -0,0 +1,6 @@
+---
+title: archetype
+details: /content-management/archetypes
+---
+
+An _archetype_ is a template for new content.
diff --git a/content/en/quick-reference/glossary/argument.md b/content/en/quick-reference/glossary/argument.md
new file mode 100644
index 000000000..912951d2b
--- /dev/null
+++ b/content/en/quick-reference/glossary/argument.md
@@ -0,0 +1,5 @@
+---
+title: argument
+---
+
+An _argument_ is a [_scalar_](g), [_array_](g), [_slice_](g), [_map_](g), or [_object_](g) passed to a [_function_](g), [_method_](g), or [_shortcode_](g).
diff --git a/content/en/quick-reference/glossary/array.md b/content/en/quick-reference/glossary/array.md
new file mode 100644
index 000000000..0df45f212
--- /dev/null
+++ b/content/en/quick-reference/glossary/array.md
@@ -0,0 +1,6 @@
+---
+title: array
+reference: https://go.dev/ref/spec#Array_types
+---
+
+An _array_ is a numbered sequence of [_elements_](g). Unlike Go's [_slice_](g) data type, an array has a fixed length. Elements within an array can be [_scalars_](g), slices, [_maps_](g), pages, or other arrays.
diff --git a/content/en/quick-reference/glossary/asset-pipeline.md b/content/en/quick-reference/glossary/asset-pipeline.md
new file mode 100644
index 000000000..5f3264a6e
--- /dev/null
+++ b/content/en/quick-reference/glossary/asset-pipeline.md
@@ -0,0 +1,5 @@
+---
+title: asset pipeline
+---
+
+An _asset pipeline_ is a system that automates and optimizes the handling of static assets like images, stylesheets, and JavaScript files.
diff --git a/content/en/getting-started/glossary/bool.md b/content/en/quick-reference/glossary/bool.md
similarity index 51%
rename from content/en/getting-started/glossary/bool.md
rename to content/en/quick-reference/glossary/bool.md
index 7fd7628ca..a4f33b5b9 100644
--- a/content/en/getting-started/glossary/bool.md
+++ b/content/en/quick-reference/glossary/bool.md
@@ -2,4 +2,4 @@
title: bool
---
-See [boolean](g).
+See [_boolean_](g).
diff --git a/content/en/quick-reference/glossary/boolean.md b/content/en/quick-reference/glossary/boolean.md
new file mode 100644
index 000000000..e727c40b0
--- /dev/null
+++ b/content/en/quick-reference/glossary/boolean.md
@@ -0,0 +1,5 @@
+---
+title: boolean
+---
+
+A _boolean_ is a data type with two possible values, either `true` or `false`.
diff --git a/content/en/quick-reference/glossary/branch-bundle.md b/content/en/quick-reference/glossary/branch-bundle.md
new file mode 100644
index 000000000..d5688ba0b
--- /dev/null
+++ b/content/en/quick-reference/glossary/branch-bundle.md
@@ -0,0 +1,6 @@
+---
+title: branch bundle
+reference: /content-management/page-bundles
+---
+
+A _branch bundle_ is a top-level content directory or any content directory containing an `_index.md` file. Analogous to a physical branch, a branch bundle may have descendants including [_leaf bundles_](g) and other branch bundles. A branch bundle may also contain [_page resources_](g) such as images.
diff --git a/content/en/quick-reference/glossary/build.md b/content/en/quick-reference/glossary/build.md
new file mode 100644
index 000000000..79b7ec74a
--- /dev/null
+++ b/content/en/quick-reference/glossary/build.md
@@ -0,0 +1,5 @@
+---
+title: build
+---
+
+To _build_ a site is to generate HTML files and assets such as images, CSS files, and JavaScript files. The build process includes rendering and resource transformations.
diff --git a/content/en/getting-started/glossary/bundle.md b/content/en/quick-reference/glossary/bundle.md
similarity index 100%
rename from content/en/getting-started/glossary/bundle.md
rename to content/en/quick-reference/glossary/bundle.md
diff --git a/content/en/quick-reference/glossary/cache.md b/content/en/quick-reference/glossary/cache.md
new file mode 100644
index 000000000..a86068e4a
--- /dev/null
+++ b/content/en/quick-reference/glossary/cache.md
@@ -0,0 +1,5 @@
+---
+title: cache
+---
+
+A _cache_ is a software component that stores data so that future requests for the same data are faster.
diff --git a/content/en/quick-reference/glossary/chain.md b/content/en/quick-reference/glossary/chain.md
new file mode 100644
index 000000000..bbbc14f49
--- /dev/null
+++ b/content/en/quick-reference/glossary/chain.md
@@ -0,0 +1,5 @@
+---
+title: chain
+---
+
+To _chain_ is to connect one or more [_identifiers_](g) with a dot. An identifier can represent a [_method_](g), [_object_](g), or [_field_](g). For example, `.Site.Params.author.name` or `.Date.UTC.Hour`.
diff --git a/content/en/quick-reference/glossary/cjk.md b/content/en/quick-reference/glossary/cjk.md
new file mode 100644
index 000000000..05a294d44
--- /dev/null
+++ b/content/en/quick-reference/glossary/cjk.md
@@ -0,0 +1,5 @@
+---
+title: CJK
+---
+
+_CJK_ is a collective term for the Chinese, Japanese, and Korean languages.
diff --git a/content/en/quick-reference/glossary/cli.md b/content/en/quick-reference/glossary/cli.md
new file mode 100644
index 000000000..61269dc8e
--- /dev/null
+++ b/content/en/quick-reference/glossary/cli.md
@@ -0,0 +1,5 @@
+---
+title: CLI
+---
+
+_CLI_ is an abbreviation of Command Line Interface.
diff --git a/content/en/quick-reference/glossary/collection.md b/content/en/quick-reference/glossary/collection.md
new file mode 100644
index 000000000..30e1ef805
--- /dev/null
+++ b/content/en/quick-reference/glossary/collection.md
@@ -0,0 +1,5 @@
+---
+title: collection
+---
+
+A _collection_ is an [_array_](g), [_slice_](g), or [_map_](g).
diff --git a/content/en/quick-reference/glossary/content-adapter.md b/content/en/quick-reference/glossary/content-adapter.md
new file mode 100644
index 000000000..974e61dca
--- /dev/null
+++ b/content/en/quick-reference/glossary/content-adapter.md
@@ -0,0 +1,6 @@
+---
+title: content adapter
+reference: /content-management/content-adapters
+---
+
+A _content adapter_ is a template that dynamically creates pages when building a site. For example, use a content adapter to create pages from a remote data source such as JSON, TOML, YAML, or XML.
diff --git a/content/en/quick-reference/glossary/content-format.md b/content/en/quick-reference/glossary/content-format.md
new file mode 100644
index 000000000..ea459deb7
--- /dev/null
+++ b/content/en/quick-reference/glossary/content-format.md
@@ -0,0 +1,6 @@
+---
+title: content format
+reference: /content-management/formats
+---
+
+A _content format_ is a markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText.
diff --git a/content/en/quick-reference/glossary/content-type.md b/content/en/quick-reference/glossary/content-type.md
new file mode 100644
index 000000000..b7ebc5be4
--- /dev/null
+++ b/content/en/quick-reference/glossary/content-type.md
@@ -0,0 +1,6 @@
+---
+title: content type
+reference: /content-management/types
+---
+
+A _content type_ is a classification of content inferred from the top-level directory name or the `type` set in [front matter](g). Pages in the root of the `content` directory, including the home page, are of type "page". Accessed via `.Page.Type` in [_templates_](g).
diff --git a/content/en/quick-reference/glossary/content-view.md b/content/en/quick-reference/glossary/content-view.md
new file mode 100644
index 000000000..009981cb5
--- /dev/null
+++ b/content/en/quick-reference/glossary/content-view.md
@@ -0,0 +1,6 @@
+---
+title: content view
+reference: /templates/content-view
+---
+
+A _content view_ is a template called with the [`Render`](/methods/page/render/) method on a `Page` object.
diff --git a/content/en/quick-reference/glossary/context.md b/content/en/quick-reference/glossary/context.md
new file mode 100644
index 000000000..75afc709d
--- /dev/null
+++ b/content/en/quick-reference/glossary/context.md
@@ -0,0 +1,6 @@
+---
+title: context
+reference: /templates/introduction/#context
+---
+
+Represented by a dot (`.`) within a [_template action_](g), _context_ is the current location in a data structure. For example, while iterating over a [_collection_](g) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called.
diff --git a/content/en/quick-reference/glossary/default-sort-order.md b/content/en/quick-reference/glossary/default-sort-order.md
new file mode 100644
index 000000000..2b5588d56
--- /dev/null
+++ b/content/en/quick-reference/glossary/default-sort-order.md
@@ -0,0 +1,5 @@
+---
+title: default sort order
+---
+
+The _default sort order_ is the default order in which Hugo sorts page collections: by [_weight_](g), then by date (descending), then by link title, and then by file path.
diff --git a/content/en/quick-reference/glossary/duration.md b/content/en/quick-reference/glossary/duration.md
new file mode 100644
index 000000000..21fd3c832
--- /dev/null
+++ b/content/en/quick-reference/glossary/duration.md
@@ -0,0 +1,5 @@
+---
+title: duration
+---
+
+A _duration_ is a data type that represent a length of time, expressed using units such as seconds (represented by `s`), minutes (represented by `m`), and hours (represented by `h`). For example, `42s` means 42 seconds, `6m7s` means 6 minutes and 7 seconds, and `6h7m42s` means 6 hours, 7 minutes, and 42 seconds.
diff --git a/content/en/quick-reference/glossary/element.md b/content/en/quick-reference/glossary/element.md
new file mode 100644
index 000000000..39f5df656
--- /dev/null
+++ b/content/en/quick-reference/glossary/element.md
@@ -0,0 +1,5 @@
+---
+title: element
+---
+
+An _element_ is a member of a [_slice_](g) or [_array_](g).
diff --git a/content/en/quick-reference/glossary/embedded-template.md b/content/en/quick-reference/glossary/embedded-template.md
new file mode 100644
index 000000000..3a0871690
--- /dev/null
+++ b/content/en/quick-reference/glossary/embedded-template.md
@@ -0,0 +1,5 @@
+---
+title: embedded template
+---
+
+An _embedded template_ is a built-in component within the Hugo application. This includes features like [_partials_](g), [_shortcodes_](g), and [_render hooks_](g) that provide pre-defined structures or functionalities for creating website content.
diff --git a/content/en/getting-started/glossary/environment.md b/content/en/quick-reference/glossary/environment.md
similarity index 70%
rename from content/en/getting-started/glossary/environment.md
rename to content/en/quick-reference/glossary/environment.md
index 9479605cd..6605c2263 100644
--- a/content/en/getting-started/glossary/environment.md
+++ b/content/en/quick-reference/glossary/environment.md
@@ -2,7 +2,7 @@
title: environment
---
-Typically one of `development`, `staging`, or `production`, each environment may exhibit different behavior depending on configuration and template logic. For example, in a production environment you might minify and fingerprint CSS, but that probably doesn't make sense in a development environment.
+Typically one of `development`, `staging`, or `production`, each _environment_ may exhibit different behavior depending on configuration and template logic. For example, in a production environment you might minify and fingerprint CSS, but that probably doesn't make sense in a development environment.
When running the built-in development server with the `hugo server` command, the environment is set to `development`. When building your site with the `hugo` command, the environment is set to `production`. To override the environment value, use the `--environment` command line flag or the `HUGO_ENVIRONMENT` environment variable.
diff --git a/content/en/quick-reference/glossary/field.md b/content/en/quick-reference/glossary/field.md
new file mode 100644
index 000000000..a32eb3a6b
--- /dev/null
+++ b/content/en/quick-reference/glossary/field.md
@@ -0,0 +1,5 @@
+---
+title: field
+---
+
+A _field_ is a predefined key-value pair in front matter such as `date` or `title`.
diff --git a/content/en/quick-reference/glossary/flag.md b/content/en/quick-reference/glossary/flag.md
new file mode 100644
index 000000000..e7b6c5746
--- /dev/null
+++ b/content/en/quick-reference/glossary/flag.md
@@ -0,0 +1,6 @@
+---
+title: flag
+reference: /commands/hugo
+---
+
+A _flag_ is an option passed to a command-line program, beginning with one or two hyphens.
diff --git a/content/en/getting-started/glossary/float.md b/content/en/quick-reference/glossary/float.md
similarity index 100%
rename from content/en/getting-started/glossary/float.md
rename to content/en/quick-reference/glossary/float.md
diff --git a/content/en/quick-reference/glossary/floating-point.md b/content/en/quick-reference/glossary/floating-point.md
new file mode 100644
index 000000000..38ba9f012
--- /dev/null
+++ b/content/en/quick-reference/glossary/floating-point.md
@@ -0,0 +1,5 @@
+---
+title: floating point
+---
+
+The term _floating point_ refers to a numeric data type with a fractional component. For example, `3.14159`.
diff --git a/content/en/quick-reference/glossary/fragment.md b/content/en/quick-reference/glossary/fragment.md
new file mode 100644
index 000000000..57ef1b4ef
--- /dev/null
+++ b/content/en/quick-reference/glossary/fragment.md
@@ -0,0 +1,5 @@
+---
+title: fragment
+---
+
+A _fragment_ is the final segment of a URL, beginning with a hash (`#`) mark, that references an `id` attribute of an HTML element on the page.
diff --git a/content/en/quick-reference/glossary/front-matter.md b/content/en/quick-reference/glossary/front-matter.md
new file mode 100644
index 000000000..5a3cd3040
--- /dev/null
+++ b/content/en/quick-reference/glossary/front-matter.md
@@ -0,0 +1,6 @@
+---
+title: front matter
+reference: /content-management/front-matter
+---
+
+The term _front matter_ refers to the metadata at the beginning of each content page, separated from the content by format-specific delimiters.
diff --git a/content/en/quick-reference/glossary/function.md b/content/en/quick-reference/glossary/function.md
new file mode 100644
index 000000000..a7da52cd2
--- /dev/null
+++ b/content/en/quick-reference/glossary/function.md
@@ -0,0 +1,6 @@
+---
+title: function
+reference: /functions
+---
+
+Used within a [_template action_](g), a _function_ takes one or more [_arguments_](g) and returns a value. Unlike [_methods_](g), functions are not associated with an [_object_](g).
diff --git a/content/en/quick-reference/glossary/glob.md b/content/en/quick-reference/glossary/glob.md
new file mode 100644
index 000000000..5243d1ef9
--- /dev/null
+++ b/content/en/quick-reference/glossary/glob.md
@@ -0,0 +1,6 @@
+---
+title: glob
+reference: https://github.com/gobwas/glob?tab=readme-ov-file#example
+---
+
+A _glob_ is a pattern used to match filenames and paths. It's a shorthand for specifying a set of files, making it easier to work with multiple files at once.
diff --git a/content/en/quick-reference/glossary/global-resource.md b/content/en/quick-reference/glossary/global-resource.md
new file mode 100644
index 000000000..a4df65f67
--- /dev/null
+++ b/content/en/quick-reference/glossary/global-resource.md
@@ -0,0 +1,5 @@
+---
+title: global resource
+---
+
+A _global resource_ is file within the `assets` directory, or within any directory mounted to the `assets` directory.
diff --git a/content/en/quick-reference/glossary/headless-bundle.md b/content/en/quick-reference/glossary/headless-bundle.md
new file mode 100644
index 000000000..ac7bf79c8
--- /dev/null
+++ b/content/en/quick-reference/glossary/headless-bundle.md
@@ -0,0 +1,6 @@
+---
+title: headless bundle
+reference: /content-management/build-options/
+---
+
+A _headless bundle_ is an unpublished [_leaf bundle_](g) or an unpublished [_branch bundle_](g) whose content and resources you can include in other pages.
diff --git a/content/en/quick-reference/glossary/i18n.md b/content/en/quick-reference/glossary/i18n.md
new file mode 100644
index 000000000..168828aa8
--- /dev/null
+++ b/content/en/quick-reference/glossary/i18n.md
@@ -0,0 +1,5 @@
+---
+title: i18n
+---
+
+See [_internationalization_](g).
diff --git a/content/en/quick-reference/glossary/identifier.md b/content/en/quick-reference/glossary/identifier.md
new file mode 100644
index 000000000..f53472fa7
--- /dev/null
+++ b/content/en/quick-reference/glossary/identifier.md
@@ -0,0 +1,5 @@
+---
+title: identifier
+---
+
+An _identifier_ is a string that represents a variable, method, object, or field. It must conform to Go's [language specification](https://go.dev/ref/spec#Identifiers), beginning with a letter or underscore, followed by zero or more letters, digits, or underscores.
diff --git a/content/en/getting-started/glossary/int.md b/content/en/quick-reference/glossary/int.md
similarity index 50%
rename from content/en/getting-started/glossary/int.md
rename to content/en/quick-reference/glossary/int.md
index 1077ee5e0..0896f1ce7 100644
--- a/content/en/getting-started/glossary/int.md
+++ b/content/en/quick-reference/glossary/int.md
@@ -2,4 +2,4 @@
title: int
---
-See [integer](g).
+See [_integer_](g).
diff --git a/content/en/quick-reference/glossary/integer.md b/content/en/quick-reference/glossary/integer.md
new file mode 100644
index 000000000..0af821300
--- /dev/null
+++ b/content/en/quick-reference/glossary/integer.md
@@ -0,0 +1,5 @@
+---
+title: integer
+---
+
+An _integer_ is a numeric data type without a fractional component. For example, `42`.
diff --git a/content/en/quick-reference/glossary/internationalization.md b/content/en/quick-reference/glossary/internationalization.md
new file mode 100644
index 000000000..4e8b0199c
--- /dev/null
+++ b/content/en/quick-reference/glossary/internationalization.md
@@ -0,0 +1,5 @@
+---
+title: internationalization
+---
+
+The term _internationalization_ refers to software design and development efforts that enable [_localization_](g).
diff --git a/content/en/quick-reference/glossary/interpreted-string-literal.md b/content/en/quick-reference/glossary/interpreted-string-literal.md
new file mode 100644
index 000000000..a5d2cd326
--- /dev/null
+++ b/content/en/quick-reference/glossary/interpreted-string-literal.md
@@ -0,0 +1,6 @@
+---
+title: interpreted string literal
+reference: https://go.dev/ref/spec#String_literals
+---
+
+An _interpreted string literal_ is a character sequences between double quotes, as in "foo". Within the quotes, any character may appear except a newline and an unescaped double quote. The text between the quotes forms the value of the literal, with backslash escapes interpreted.
diff --git a/content/en/quick-reference/glossary/interval.md b/content/en/quick-reference/glossary/interval.md
new file mode 100644
index 000000000..f1ce7bc93
--- /dev/null
+++ b/content/en/quick-reference/glossary/interval.md
@@ -0,0 +1,11 @@
+---
+title: interval
+---
+
+An [_interval_](https://en.wikipedia.org/wiki/Interval_(mathematics)) is a range of numbers between two endpoints: closed, open, or half-open.
+
+- A _closed interval_, denoted by brackets, includes its endpoints. For example, [0, 1] is the interval where `0 <= x <= 1`.
+
+- An _open interval_, denoted by parentheses, excludes its endpoints. For example, (0, 1) is the interval where `0 < x < 1`.
+
+- A _half-open interval_ includes only one of its endpoints. For example, (0, 1] is the _left-open_ interval where `0 < x <= 1`, while [0, 1) is the _right-open_ interval where `0 <= x < 1`.
diff --git a/content/en/quick-reference/glossary/kind.md b/content/en/quick-reference/glossary/kind.md
new file mode 100644
index 000000000..a214dfbf1
--- /dev/null
+++ b/content/en/quick-reference/glossary/kind.md
@@ -0,0 +1,5 @@
+---
+title: kind
+---
+
+See [_page kind_](g).
diff --git a/content/en/quick-reference/glossary/l10n.md b/content/en/quick-reference/glossary/l10n.md
new file mode 100644
index 000000000..013d0ab55
--- /dev/null
+++ b/content/en/quick-reference/glossary/l10n.md
@@ -0,0 +1,5 @@
+---
+title: l10n
+---
+
+See [_localization_](g).
diff --git a/content/en/getting-started/glossary/layout.md b/content/en/quick-reference/glossary/layout.md
similarity index 52%
rename from content/en/getting-started/glossary/layout.md
rename to content/en/quick-reference/glossary/layout.md
index 706e9439d..a4e6b33f1 100644
--- a/content/en/getting-started/glossary/layout.md
+++ b/content/en/quick-reference/glossary/layout.md
@@ -2,4 +2,4 @@
title: layout
---
-See [template](g).
+See [_template_](g).
diff --git a/content/en/quick-reference/glossary/leaf-bundle.md b/content/en/quick-reference/glossary/leaf-bundle.md
new file mode 100644
index 000000000..aa41384ee
--- /dev/null
+++ b/content/en/quick-reference/glossary/leaf-bundle.md
@@ -0,0 +1,6 @@
+---
+title: leaf bundle
+reference: /content-management/page-bundles/
+---
+
+A _leaf bundle_ is a directory that contains an `index.md` file and zero or more [_resources_](g). Analogous to a physical leaf, a leaf bundle is at the end of a [_branch bundle_](g). It has no descendants.
diff --git a/content/en/quick-reference/glossary/lexer.md b/content/en/quick-reference/glossary/lexer.md
new file mode 100644
index 000000000..a46223148
--- /dev/null
+++ b/content/en/quick-reference/glossary/lexer.md
@@ -0,0 +1,5 @@
+---
+title: lexer
+---
+
+A _lexer_ is a software component that identifies keywords, identifiers, operators, numbers, and other basic building blocks of a programming language within the input text.
diff --git a/content/en/quick-reference/glossary/list-page.md b/content/en/quick-reference/glossary/list-page.md
new file mode 100644
index 000000000..b58ee4a35
--- /dev/null
+++ b/content/en/quick-reference/glossary/list-page.md
@@ -0,0 +1,5 @@
+---
+title: list page
+---
+
+A list page is any [_page kind_](g) that receives a page [_collection_](g) in [_context_](g). This includes the home page, [section pages](g), [taxonomy pages](g), and [term pages](g).
diff --git a/content/en/quick-reference/glossary/list-template.md b/content/en/quick-reference/glossary/list-template.md
new file mode 100644
index 000000000..9a12a275f
--- /dev/null
+++ b/content/en/quick-reference/glossary/list-template.md
@@ -0,0 +1,5 @@
+---
+title: list template
+---
+
+A _list template_ is any [_template_](g) that renders a [_list page_](g). This includes home, [_section_](g), [_taxonomy_](g), and [_term_](g) templates.
diff --git a/content/en/quick-reference/glossary/localization.md b/content/en/quick-reference/glossary/localization.md
new file mode 100644
index 000000000..01f450635
--- /dev/null
+++ b/content/en/quick-reference/glossary/localization.md
@@ -0,0 +1,6 @@
+---
+title: localization
+reference: /content-management/multilingual/
+---
+
+The term _localization_ refers to the process of adapting a site to meet language and regional requirements. This includes translations, date formats, number formats, currency formats, and collation order.
diff --git a/content/en/quick-reference/glossary/logical-path.md b/content/en/quick-reference/glossary/logical-path.md
new file mode 100644
index 000000000..aa5ce9374
--- /dev/null
+++ b/content/en/quick-reference/glossary/logical-path.md
@@ -0,0 +1,8 @@
+---
+title: logical path
+reference: /methods/page/path/#examples
+---
+
+{{< new-in 0.123.0 />}}
+
+A _logical path_ is a page or page resource identifier derived from the file path, excluding its extension and language identifier. This value is neither a file path nor a URL. Starting with a file path relative to the `content` directory, Hugo determines the logical path by stripping the file extension and language identifier, converting to lower case, then replacing spaces with hyphens.
diff --git a/content/en/quick-reference/glossary/map.md b/content/en/quick-reference/glossary/map.md
new file mode 100644
index 000000000..b4605d20b
--- /dev/null
+++ b/content/en/quick-reference/glossary/map.md
@@ -0,0 +1,6 @@
+---
+title: map
+reference: https://go.dev/ref/spec#Map_types
+---
+
+A _map_ is an unordered group of elements, each indexed by a unique key.
diff --git a/content/en/quick-reference/glossary/markdown-attribute.md b/content/en/quick-reference/glossary/markdown-attribute.md
new file mode 100644
index 000000000..ccbcefd66
--- /dev/null
+++ b/content/en/quick-reference/glossary/markdown-attribute.md
@@ -0,0 +1,6 @@
+---
+title: Markdown attribute
+reference: /content-management/markdown-attributes/
+---
+
+A _Markdown attribute_ is a key-value pair attached to a Markdown element. These attributes are commonly used to add HTML attributes, like `class` and `id`, to the element when it's rendered into HTML. They provide a way to extend the basic Markdown syntax and add more semantic meaning or styling hooks to your content.
diff --git a/content/en/quick-reference/glossary/marshal.md b/content/en/quick-reference/glossary/marshal.md
new file mode 100644
index 000000000..3bb1623f5
--- /dev/null
+++ b/content/en/quick-reference/glossary/marshal.md
@@ -0,0 +1,6 @@
+---
+title: marshal
+reference: /functions/transform/remarshal/
+---
+
+To _marshal_ is to transform a data structure into a serialized object. For example, transforming a [_map_](g) into a JSON string.
diff --git a/content/en/quick-reference/glossary/method.md b/content/en/quick-reference/glossary/method.md
new file mode 100644
index 000000000..b7618bbf9
--- /dev/null
+++ b/content/en/quick-reference/glossary/method.md
@@ -0,0 +1,5 @@
+---
+title: method
+---
+
+Used within a [_template action_](g) and associated with an [_object_](g), a _method_ takes zero or more [_arguments_](g) and either returns a value or performs an action. For example, `.IsHome` is a method on the `.Page` object which returns `true` if the current page is the home page. See also [_function_](g).
diff --git a/content/en/quick-reference/glossary/module.md b/content/en/quick-reference/glossary/module.md
new file mode 100644
index 000000000..90c8ff80b
--- /dev/null
+++ b/content/en/quick-reference/glossary/module.md
@@ -0,0 +1,6 @@
+---
+title: module
+reference: /hugo-modules/
+---
+
+A _module_ is a packaged combination of [_archetypes_](g), assets, content, data, [_templates_](g), translation tables, static files, or configuration settings. A module may serve as the basis for a new site, or to augment an existing site.
diff --git a/content/en/quick-reference/glossary/node.md b/content/en/quick-reference/glossary/node.md
new file mode 100644
index 000000000..b722e07c8
--- /dev/null
+++ b/content/en/quick-reference/glossary/node.md
@@ -0,0 +1,5 @@
+---
+title: node
+---
+
+A _node_ is a class of [_page kinds_](g) including `home`, `section`, `taxonomy`, and `term`.
diff --git a/content/en/getting-started/glossary/noop.md b/content/en/quick-reference/glossary/noop.md
similarity index 100%
rename from content/en/getting-started/glossary/noop.md
rename to content/en/quick-reference/glossary/noop.md
diff --git a/content/en/quick-reference/glossary/object.md b/content/en/quick-reference/glossary/object.md
new file mode 100644
index 000000000..216609d0d
--- /dev/null
+++ b/content/en/quick-reference/glossary/object.md
@@ -0,0 +1,5 @@
+---
+title: object
+---
+
+An _object_ is a data structure with or without associated [_methods_](g).
diff --git a/content/en/quick-reference/glossary/ordered-taxonomy.md b/content/en/quick-reference/glossary/ordered-taxonomy.md
new file mode 100644
index 000000000..7e0e2763d
--- /dev/null
+++ b/content/en/quick-reference/glossary/ordered-taxonomy.md
@@ -0,0 +1,8 @@
+---
+title: ordered taxonomy
+---
+
+Created by invoking the [`Alphabetical`] or [`ByCount`] method on a [`Taxonomy`](g) object, which is a [_map_](g), an _ordered taxonomy_ is a [_slice_](g), where each element is an object that contains the [_term_](g) and a slice of its [weighted pages](g).
+
+[`Alphabetical`]: /methods/taxonomy/alphabetical/
+[`ByCount`]: /methods/taxonomy/bycount/
diff --git a/content/en/quick-reference/glossary/output-format.md b/content/en/quick-reference/glossary/output-format.md
new file mode 100644
index 000000000..9004dc223
--- /dev/null
+++ b/content/en/quick-reference/glossary/output-format.md
@@ -0,0 +1,6 @@
+---
+title: output format
+reference: /templates/output-formats/
+---
+
+An _output format_ is a collection of settings that defines how Hugo renders a file when building a site. For example, `html`, `rss`, and `json` are built-in output formats. You can create multiple output formats and control their generation based on [page kind](g), or by enabling one or more output formats for specific pages.
diff --git a/content/en/quick-reference/glossary/page-bundle.md b/content/en/quick-reference/glossary/page-bundle.md
new file mode 100644
index 000000000..af76da2aa
--- /dev/null
+++ b/content/en/quick-reference/glossary/page-bundle.md
@@ -0,0 +1,6 @@
+---
+title: page bundle
+reference: /content-management/page-bundles/
+---
+
+A _page bundle_ is a directory that encapsulates both content and associated [_resources_](g). There are two types of page bundles: [_leaf bundles_](g) and [_branch bundles_](g).
diff --git a/content/en/quick-reference/glossary/page-collection.md b/content/en/quick-reference/glossary/page-collection.md
new file mode 100644
index 000000000..f078ecf27
--- /dev/null
+++ b/content/en/quick-reference/glossary/page-collection.md
@@ -0,0 +1,5 @@
+---
+title: page collection
+---
+
+A _page collection_ is a slice of `Page` objects.
diff --git a/content/en/quick-reference/glossary/page-kind.md b/content/en/quick-reference/glossary/page-kind.md
new file mode 100644
index 000000000..ee47fe010
--- /dev/null
+++ b/content/en/quick-reference/glossary/page-kind.md
@@ -0,0 +1,6 @@
+---
+title: page kind
+reference: /methods/page/kind/
+---
+
+A _page kind_ is a classification of pages, one of `home`, `page`, `section`, `taxonomy`, or `term`.
diff --git a/content/en/quick-reference/glossary/page-resource.md b/content/en/quick-reference/glossary/page-resource.md
new file mode 100644
index 000000000..dab119eb4
--- /dev/null
+++ b/content/en/quick-reference/glossary/page-resource.md
@@ -0,0 +1,5 @@
+---
+title: page resource
+---
+
+A _page resource_ is a file within a [_page bundle_](g).
diff --git a/content/en/quick-reference/glossary/pager.md b/content/en/quick-reference/glossary/pager.md
new file mode 100644
index 000000000..f58874e4a
--- /dev/null
+++ b/content/en/quick-reference/glossary/pager.md
@@ -0,0 +1,5 @@
+---
+title: pager
+---
+
+Created during [_pagination_](g), a _pager_ contains a subset of a list page and navigation links to other pagers.
diff --git a/content/en/quick-reference/glossary/paginate.md b/content/en/quick-reference/glossary/paginate.md
new file mode 100644
index 000000000..d2467e098
--- /dev/null
+++ b/content/en/quick-reference/glossary/paginate.md
@@ -0,0 +1,5 @@
+---
+title: paginate
+---
+
+To _paginate_ is to split a list page into two or more subsets.
diff --git a/content/en/quick-reference/glossary/pagination.md b/content/en/quick-reference/glossary/pagination.md
new file mode 100644
index 000000000..136341dbf
--- /dev/null
+++ b/content/en/quick-reference/glossary/pagination.md
@@ -0,0 +1,6 @@
+---
+title: pagination
+reference: /templates/pagination
+---
+
+The term _pagination_ refers to the process of [_paginating_](g) a list page.
diff --git a/content/en/quick-reference/glossary/paginator.md b/content/en/quick-reference/glossary/paginator.md
new file mode 100644
index 000000000..4d197348d
--- /dev/null
+++ b/content/en/quick-reference/glossary/paginator.md
@@ -0,0 +1,5 @@
+---
+title: paginator
+---
+
+A _paginator_ is a collection of [_pagers_](g).
diff --git a/content/en/quick-reference/glossary/parameter.md b/content/en/quick-reference/glossary/parameter.md
new file mode 100644
index 000000000..f1a45ea34
--- /dev/null
+++ b/content/en/quick-reference/glossary/parameter.md
@@ -0,0 +1,5 @@
+---
+title: parameter
+---
+
+A _parameter_ is typically a user-defined key-value pair at the site or page level, but may also refer to a configuration setting or an [_argument_](g).
diff --git a/content/en/quick-reference/glossary/partial.md b/content/en/quick-reference/glossary/partial.md
new file mode 100644
index 000000000..a5dd5e51a
--- /dev/null
+++ b/content/en/quick-reference/glossary/partial.md
@@ -0,0 +1,5 @@
+---
+title: partial
+---
+
+A _partial_ is a [_template_](g) called from any other template including [_shortcodes_](g), [render hooks](g), and other partials. A partial either renders something or returns something. A partial can also call itself, for example, to [_walk_](g) a data structure.
diff --git a/content/en/quick-reference/glossary/permalink.md b/content/en/quick-reference/glossary/permalink.md
new file mode 100644
index 000000000..45651de83
--- /dev/null
+++ b/content/en/quick-reference/glossary/permalink.md
@@ -0,0 +1,5 @@
+---
+title: permalink
+---
+
+A _permalink_ is the absolute URL of a published resource or a rendered page, including scheme and host.
diff --git a/content/en/getting-started/glossary/pipe.md b/content/en/quick-reference/glossary/pipe.md
similarity index 50%
rename from content/en/getting-started/glossary/pipe.md
rename to content/en/quick-reference/glossary/pipe.md
index 4daab1999..f587eeccf 100644
--- a/content/en/getting-started/glossary/pipe.md
+++ b/content/en/quick-reference/glossary/pipe.md
@@ -2,4 +2,4 @@
title: pipe
---
-See [pipeline](g).
+See [_pipeline_](g).
diff --git a/content/en/quick-reference/glossary/pipeline.md b/content/en/quick-reference/glossary/pipeline.md
new file mode 100644
index 000000000..2bb3fa3b7
--- /dev/null
+++ b/content/en/quick-reference/glossary/pipeline.md
@@ -0,0 +1,7 @@
+---
+title: pipeline
+---
+
+Within a [_template action_](g), a _pipeline_ is a possibly chained sequence of values, [_function_](g) calls, or [_method_](g) calls. Functions and methods in the pipeline may take multiple [_arguments_](g).
+
+A pipeline may be *chained* by separating a sequence of commands with pipeline characters (`|`). In a chained pipeline, the result of each command is passed as the last argument to the following command. The output of the final command in the pipeline is the value of the pipeline.
diff --git a/content/en/quick-reference/glossary/pretty-url.md b/content/en/quick-reference/glossary/pretty-url.md
new file mode 100644
index 000000000..b15ef9f0f
--- /dev/null
+++ b/content/en/quick-reference/glossary/pretty-url.md
@@ -0,0 +1,5 @@
+---
+title: pretty URL
+---
+
+A _pretty URL_ is a URL that does not include a file extension.
diff --git a/content/en/getting-started/glossary/publish.md b/content/en/quick-reference/glossary/publish.md
similarity index 57%
rename from content/en/getting-started/glossary/publish.md
rename to content/en/quick-reference/glossary/publish.md
index 1a7a491af..743e87a3e 100644
--- a/content/en/getting-started/glossary/publish.md
+++ b/content/en/quick-reference/glossary/publish.md
@@ -2,4 +2,4 @@
title: publish
---
-See [build](g).
+See [_build_](g).
diff --git a/content/en/quick-reference/glossary/raw-string-literal.md b/content/en/quick-reference/glossary/raw-string-literal.md
new file mode 100644
index 000000000..7465c6837
--- /dev/null
+++ b/content/en/quick-reference/glossary/raw-string-literal.md
@@ -0,0 +1,6 @@
+---
+title: raw string literal
+reference: https://go.dev/ref/spec#String_literals
+---
+
+A _raw string literal_ is a character sequences between backticks, as in \`bar\`. Within the backticks, any character may appear except a backtick. Backslashes have no special meaning and the string may contain newlines. Carriage return characters (`\r`) inside raw string literals are discarded from the raw string value.
diff --git a/content/en/quick-reference/glossary/regular-page.md b/content/en/quick-reference/glossary/regular-page.md
new file mode 100644
index 000000000..084408e57
--- /dev/null
+++ b/content/en/quick-reference/glossary/regular-page.md
@@ -0,0 +1,5 @@
+---
+title: regular page
+---
+
+A _regular page_ is a page with the "page" [_page kind_](g). See also [_section page_](g).
diff --git a/content/en/quick-reference/glossary/relative-permalink.md b/content/en/quick-reference/glossary/relative-permalink.md
new file mode 100644
index 000000000..a272133a3
--- /dev/null
+++ b/content/en/quick-reference/glossary/relative-permalink.md
@@ -0,0 +1,5 @@
+---
+title: relative permalink
+---
+
+A _relative permalink_ is the host-relative URL of a published resource or a rendered page.
diff --git a/content/en/quick-reference/glossary/remote-resource.md b/content/en/quick-reference/glossary/remote-resource.md
new file mode 100644
index 000000000..163749763
--- /dev/null
+++ b/content/en/quick-reference/glossary/remote-resource.md
@@ -0,0 +1,5 @@
+---
+title: remote resource
+---
+
+A _remote resource_ is a file on a remote server, accessible via HTTP or HTTPS.
diff --git a/content/en/quick-reference/glossary/render-hook.md b/content/en/quick-reference/glossary/render-hook.md
new file mode 100644
index 000000000..2cdb98e05
--- /dev/null
+++ b/content/en/quick-reference/glossary/render-hook.md
@@ -0,0 +1,6 @@
+---
+title: render hook
+reference: /render-hooks
+---
+
+A _render hook_ is a [_template_](g) that overrides standard Markdown rendering.
diff --git a/content/en/quick-reference/glossary/resource-type.md b/content/en/quick-reference/glossary/resource-type.md
new file mode 100644
index 000000000..64d9c27ab
--- /dev/null
+++ b/content/en/quick-reference/glossary/resource-type.md
@@ -0,0 +1,8 @@
+---
+title: resource type
+---
+
+A _resource type_ is the main type of a resource's [media type]. Content files such as Markdown, HTML, AsciiDoc, Pandoc, reStructuredText, and Emacs Org Mode have resource type `page`. Other resource types include `image`, `video`, etc. Retrieve the resource type using the [`ResourceType`] method on a `Resource` object.
+
+[media type]: /methods/resource/mediatype/
+[`ResourceType`]: /methods/resource/resourcetype/
diff --git a/content/en/quick-reference/glossary/resource.md b/content/en/quick-reference/glossary/resource.md
new file mode 100644
index 000000000..bd3a9d10d
--- /dev/null
+++ b/content/en/quick-reference/glossary/resource.md
@@ -0,0 +1,7 @@
+---
+title: resource
+---
+
+A _resource_ is any file consumed by the build process to augment or generate content, structure, behavior, or presentation. For example: images, videos, content snippets, CSS, Sass, JavaScript, and data.
+
+Hugo supports three types of resources: [_global resources_](g), [_page resources_](g), and [_remote resources_](g).
diff --git a/content/en/quick-reference/glossary/scalar.md b/content/en/quick-reference/glossary/scalar.md
new file mode 100644
index 000000000..63ae27d3f
--- /dev/null
+++ b/content/en/quick-reference/glossary/scalar.md
@@ -0,0 +1,5 @@
+---
+title: scalar
+---
+
+A _scalar_ is a single value, one of [_string_](g), [_integer_](g), [floating point](g), or [_boolean_](g).
diff --git a/content/en/quick-reference/glossary/scope.md b/content/en/quick-reference/glossary/scope.md
new file mode 100644
index 000000000..5a13312a6
--- /dev/null
+++ b/content/en/quick-reference/glossary/scope.md
@@ -0,0 +1,5 @@
+---
+title: scope
+---
+
+The term _scope_ refers to the specific region of code where a [_variable_](g) or [_object_](g) is accessible. For example, a variable initialized in one [template](g) is not available within another.
diff --git a/content/en/quick-reference/glossary/scratch-pad.md b/content/en/quick-reference/glossary/scratch-pad.md
new file mode 100644
index 000000000..f94d4fd5b
--- /dev/null
+++ b/content/en/quick-reference/glossary/scratch-pad.md
@@ -0,0 +1,8 @@
+---
+title: scratch pad
+---
+
+Conceptually, a _scratch pad_ is a [_map_](g) with [_methods_](g) to set, get, update, and delete values. Attach the data structure to a `Page` or `Site` object using the [`Store`] method, or create a locally scoped scratch pad using the [`newScratch`] function.
+
+[`Store`]: /methods/page/store/
+[`newScratch`]: /functions/collections/newscratch/
diff --git a/content/en/quick-reference/glossary/section-page.md b/content/en/quick-reference/glossary/section-page.md
new file mode 100644
index 000000000..fd84ed5f2
--- /dev/null
+++ b/content/en/quick-reference/glossary/section-page.md
@@ -0,0 +1,5 @@
+---
+title: section page
+---
+
+A _section page_ is a page with the "section" [_page kind_](g). Typically a listing of [_regular pages_](g) and/or other section pages within the current [_section_](g).
diff --git a/content/en/quick-reference/glossary/section.md b/content/en/quick-reference/glossary/section.md
new file mode 100644
index 000000000..45d1203e0
--- /dev/null
+++ b/content/en/quick-reference/glossary/section.md
@@ -0,0 +1,5 @@
+---
+title: section
+---
+
+A _section_ is a top-level content directory or any content directory containing an `_index.md` file.
diff --git a/content/en/quick-reference/glossary/segment.md b/content/en/quick-reference/glossary/segment.md
new file mode 100644
index 000000000..5851a8825
--- /dev/null
+++ b/content/en/quick-reference/glossary/segment.md
@@ -0,0 +1,5 @@
+---
+title: segment
+---
+
+A _segment_ is a subset of a site, filtered by [_logical path_](g), language, [_page kind_](g), or [_output format_](g).
diff --git a/content/en/quick-reference/glossary/shortcode.md b/content/en/quick-reference/glossary/shortcode.md
new file mode 100644
index 000000000..bfc2f6c51
--- /dev/null
+++ b/content/en/quick-reference/glossary/shortcode.md
@@ -0,0 +1,6 @@
+---
+title: shortcode
+reference: /content-management/shortcodes
+---
+
+A _shortcode_ is a [_template_](g) invoked within markup, accepting any number of [_arguments_](g). They can be used with any [content format](g) to insert elements such as videos, images, and social media embeds into your content.
diff --git a/content/en/quick-reference/glossary/slice.md b/content/en/quick-reference/glossary/slice.md
new file mode 100644
index 000000000..5d83bed6b
--- /dev/null
+++ b/content/en/quick-reference/glossary/slice.md
@@ -0,0 +1,6 @@
+---
+title: slice
+reference: https://go.dev/ref/spec#Slice_types
+---
+
+A _slice_ is a numbered sequence of elements. Unlike Go's [_array_](g) data type, slices are dynamically sized. [_Elements_](g) within a slice can be [_scalars_](g), [_arrays_](g), [_maps_](g), pages, or other slices.
diff --git a/content/en/quick-reference/glossary/string.md b/content/en/quick-reference/glossary/string.md
new file mode 100644
index 000000000..54ed4c1d1
--- /dev/null
+++ b/content/en/quick-reference/glossary/string.md
@@ -0,0 +1,5 @@
+---
+title: string
+---
+
+A _string_ is a sequence of bytes. For example, `"What is 6 times 7?"`.
diff --git a/content/en/quick-reference/glossary/taxonomic-weight.md b/content/en/quick-reference/glossary/taxonomic-weight.md
new file mode 100644
index 000000000..682bc056c
--- /dev/null
+++ b/content/en/quick-reference/glossary/taxonomic-weight.md
@@ -0,0 +1,6 @@
+---
+title: taxonomic weight
+reference: content-management/taxonomies/#order-taxonomies
+---
+
+Defined in front matter and unique to each taxonomy, a _taxonomic weight_ is a [_weight_](g) that determines the sort order of page collections contained within a [`Taxonomy`](g) object.
diff --git a/content/en/quick-reference/glossary/taxonomy-object.md b/content/en/quick-reference/glossary/taxonomy-object.md
new file mode 100644
index 000000000..590490377
--- /dev/null
+++ b/content/en/quick-reference/glossary/taxonomy-object.md
@@ -0,0 +1,5 @@
+---
+title: taxonomy object
+---
+
+A _taxonomy object_ is a [_map_](g) of [_terms_](g) and the [weighted pages](g) associated with each term.
diff --git a/content/en/quick-reference/glossary/taxonomy-page.md b/content/en/quick-reference/glossary/taxonomy-page.md
new file mode 100644
index 000000000..6b62f0912
--- /dev/null
+++ b/content/en/quick-reference/glossary/taxonomy-page.md
@@ -0,0 +1,5 @@
+---
+title: taxonomy page
+---
+
+A _taxonomy page_ is a page with the "taxonomy" [_page kind_](g). Typically a listing of [_terms_](g) within a given [_taxonomy_](g).
diff --git a/content/en/quick-reference/glossary/taxonomy.md b/content/en/quick-reference/glossary/taxonomy.md
new file mode 100644
index 000000000..ce35a634c
--- /dev/null
+++ b/content/en/quick-reference/glossary/taxonomy.md
@@ -0,0 +1,5 @@
+---
+title: taxonomy
+reference: /content-management/taxonomies
+---
+A _taxonomy_ is a group of related [_terms_](g) used to classify content. For example, a "colors" taxonomy might include the terms "red", "green", and "blue".
diff --git a/content/en/quick-reference/glossary/template-action.md b/content/en/quick-reference/glossary/template-action.md
new file mode 100644
index 000000000..d9a6c635c
--- /dev/null
+++ b/content/en/quick-reference/glossary/template-action.md
@@ -0,0 +1,6 @@
+---
+title: template action
+reference: https://pkg.go.dev/text/template#hdr-Actions
+---
+
+A data evaluation or control structure within a [_template_](g), delimited by "{{" and "}}".
diff --git a/content/en/quick-reference/glossary/template.md b/content/en/quick-reference/glossary/template.md
new file mode 100644
index 000000000..d442c0a22
--- /dev/null
+++ b/content/en/quick-reference/glossary/template.md
@@ -0,0 +1,6 @@
+---
+title: template
+reference: /templates
+---
+
+A _template_ is a file with [_template actions_](g), located within the `layouts` directory of a project, theme, or module.
diff --git a/content/en/quick-reference/glossary/term-page.md b/content/en/quick-reference/glossary/term-page.md
new file mode 100644
index 000000000..78eabc11f
--- /dev/null
+++ b/content/en/quick-reference/glossary/term-page.md
@@ -0,0 +1,5 @@
+---
+title: term page
+---
+
+A _term page_ is a page with the "term" [_page kind_](g). Typically a listing of [_regular pages_](g) and [_section pages_](g) with a given [_term_](g).
diff --git a/content/en/quick-reference/glossary/term.md b/content/en/quick-reference/glossary/term.md
new file mode 100644
index 000000000..cafd92585
--- /dev/null
+++ b/content/en/quick-reference/glossary/term.md
@@ -0,0 +1,6 @@
+---
+title: term
+reference: /content-management/taxonomies
+---
+
+A _term_ is a member of a [_taxonomy_](g), used to classify content.
diff --git a/content/en/quick-reference/glossary/theme.md b/content/en/quick-reference/glossary/theme.md
new file mode 100644
index 000000000..84b9c684a
--- /dev/null
+++ b/content/en/quick-reference/glossary/theme.md
@@ -0,0 +1,5 @@
+---
+title: theme
+---
+
+A _theme_ is a packaged combination of [_archetypes_](g), assets, content, data, [_templates_](g), translation tables, static files, or configuration settings. A theme may serve as the basis for a new site, or to augment an existing site.
diff --git a/content/en/quick-reference/glossary/token.md b/content/en/quick-reference/glossary/token.md
new file mode 100644
index 000000000..f8c12d570
--- /dev/null
+++ b/content/en/quick-reference/glossary/token.md
@@ -0,0 +1,5 @@
+---
+title: token
+---
+
+A _token_ is an identifier within a format string, beginning with a colon and replaced with a value when rendered. For example, use tokens in format strings for both [permalinks](/content-management/urls/#permalinks) and [dates](/functions/time/format/#localization).
diff --git a/content/en/getting-started/glossary/type.md b/content/en/quick-reference/glossary/type.md
similarity index 100%
rename from content/en/getting-started/glossary/type.md
rename to content/en/quick-reference/glossary/type.md
diff --git a/content/en/quick-reference/glossary/ugly-url.md b/content/en/quick-reference/glossary/ugly-url.md
new file mode 100644
index 000000000..4083f9378
--- /dev/null
+++ b/content/en/quick-reference/glossary/ugly-url.md
@@ -0,0 +1,5 @@
+---
+title: ugly URL
+---
+
+An _ugly URL_ is a URL that includes a file extension.
diff --git a/content/en/quick-reference/glossary/unmarshal.md b/content/en/quick-reference/glossary/unmarshal.md
new file mode 100644
index 000000000..0ed548a21
--- /dev/null
+++ b/content/en/quick-reference/glossary/unmarshal.md
@@ -0,0 +1,6 @@
+---
+title: unmarshal
+reference: /functions/transform/unmarshal/
+---
+
+To _unmarshal_ is to transform a serialized object into a data structure. For example, transforming a JSON file into a [_map_](g) that you can access within a template.
diff --git a/content/en/quick-reference/glossary/variable.md b/content/en/quick-reference/glossary/variable.md
new file mode 100644
index 000000000..f8139a41f
--- /dev/null
+++ b/content/en/quick-reference/glossary/variable.md
@@ -0,0 +1,5 @@
+---
+title: variable
+---
+
+A _variable_ is a user-defined [_identifier_](g) prepended with a `$` symbol, representing a value of any data type, initialized or assigned within a [_template action_](g). For example, `$foo` and `$bar` are variables.
diff --git a/content/en/quick-reference/glossary/walk.md b/content/en/quick-reference/glossary/walk.md
new file mode 100644
index 000000000..09f9ecb20
--- /dev/null
+++ b/content/en/quick-reference/glossary/walk.md
@@ -0,0 +1,5 @@
+---
+title: walk
+---
+
+To _walk_ is to recursively traverse a nested data structure. For example, rendering a multilevel menu.
diff --git a/content/en/quick-reference/glossary/weight.md b/content/en/quick-reference/glossary/weight.md
new file mode 100644
index 000000000..deb9e6dc0
--- /dev/null
+++ b/content/en/quick-reference/glossary/weight.md
@@ -0,0 +1,5 @@
+---
+title: weight
+---
+
+A _weight_ is a numeric value used to position an element within a sorted [collection](g). Assign weights using non-zero integers. Lighter items float to the top, while heavier items sink to the bottom. Unweighted or zero-weighted elements are placed at the end of the collection. Weights are typically assigned to pages, menu entries, languages, and output formats.
diff --git a/content/en/quick-reference/glossary/weighted-page.md b/content/en/quick-reference/glossary/weighted-page.md
new file mode 100644
index 000000000..e6cf8d6db
--- /dev/null
+++ b/content/en/quick-reference/glossary/weighted-page.md
@@ -0,0 +1,5 @@
+---
+title: weighted page
+---
+
+Contained within a [_taxonomy object_](g), a _weighted page_ is a [_map_](g) with two [_elements_](g): a `Page` object, and its [_taxonomic weight_](g) as defined in front matter. Access the elements using the `Page` and `Weight` keys.
diff --git a/content/en/getting-started/glossary/zero-time.md b/content/en/quick-reference/glossary/zero-time.md
similarity index 100%
rename from content/en/getting-started/glossary/zero-time.md
rename to content/en/quick-reference/glossary/zero-time.md
diff --git a/content/en/quick-reference/methods.md b/content/en/quick-reference/methods.md
index abd1db709..5b4797f3a 100644
--- a/content/en/quick-reference/methods.md
+++ b/content/en/quick-reference/methods.md
@@ -6,8 +6,8 @@ keywords: []
menu:
docs:
parent: quick-reference
- weight: 40
-weight: 40
+ weight: 50
+weight: 50
toc: true
---
diff --git a/content/en/quick-reference/page-collections.md b/content/en/quick-reference/page-collections.md
index c86929b5b..836af3ea2 100644
--- a/content/en/quick-reference/page-collections.md
+++ b/content/en/quick-reference/page-collections.md
@@ -6,8 +6,8 @@ keywords: []
menu:
docs:
parent: quick-reference
- weight: 50
-weight: 50
+ weight: 60
+weight: 60
toc: true
---
diff --git a/content/en/render-hooks/_common/pageinner.md b/content/en/render-hooks/_common/pageinner.md
index 92bd63c56..6f2622880 100644
--- a/content/en/render-hooks/_common/pageinner.md
+++ b/content/en/render-hooks/_common/pageinner.md
@@ -4,7 +4,7 @@ _comment: Do not remove front matter.
## PageInner details
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
The primary use case for `PageInner` is to resolve links and [page resources](g) 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:
diff --git a/content/en/render-hooks/_index.md b/content/en/render-hooks/_index.md
index 8cf72c4e8..668808f44 100644
--- a/content/en/render-hooks/_index.md
+++ b/content/en/render-hooks/_index.md
@@ -1,6 +1,6 @@
---
title: Render hooks
-linkTitle: In this section
+
description: Create render hooks to override the rendering of Markdown to HTML.
categories: []
keywords: []
diff --git a/content/en/render-hooks/blockquotes.md b/content/en/render-hooks/blockquotes.md
index b0fee7239..bdeb06af9 100755
--- a/content/en/render-hooks/blockquotes.md
+++ b/content/en/render-hooks/blockquotes.md
@@ -12,7 +12,7 @@ weight: 30
toc: true
---
-{{< new-in 0.132.0 >}}
+{{< new-in 0.132.0 />}}
## Context
@@ -24,13 +24,13 @@ Blockquote render hook templates receive the following [context](g):
###### AlertTitle
-{{< new-in 0.134.0 >}}
+{{< new-in 0.134.0 />}}
(`template.HTML`) Applicable when [`Type`](#type) is `alert`, this is the alert title. See the [alerts](#alerts) section below.
###### AlertSign
-{{< new-in 0.134.0 >}}
+{{< new-in 0.134.0 />}}
(`string`) Applicable when [`Type`](#type) is `alert`, this is the alert sign. Typically used to indicate whether an alert is graphically foldable, this is one of `+`, `-`, or an empty string. See the [alerts](#alerts) section below.
diff --git a/content/en/render-hooks/code-blocks.md b/content/en/render-hooks/code-blocks.md
index 5022fd3ae..7999dbeb8 100755
--- a/content/en/render-hooks/code-blocks.md
+++ b/content/en/render-hooks/code-blocks.md
@@ -78,7 +78,7 @@ Code block render hook templates receive the following [context](g):
###### PageInner
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
(`page`) A reference to a page nested via the [`RenderShortcodes`] method. [See details](#pageinner-details).
diff --git a/content/en/render-hooks/headings.md b/content/en/render-hooks/headings.md
index 2b32797cc..7c9d6b6fe 100755
--- a/content/en/render-hooks/headings.md
+++ b/content/en/render-hooks/headings.md
@@ -41,7 +41,7 @@ title = true
###### PageInner
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
(`page`) A reference to a page nested via the [`RenderShortcodes`] method. [See details](#pageinner-details).
diff --git a/content/en/render-hooks/images.md b/content/en/render-hooks/images.md
index 900df3c2f..63f294081 100755
--- a/content/en/render-hooks/images.md
+++ b/content/en/render-hooks/images.md
@@ -59,7 +59,7 @@ block = true
###### PageInner
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
(`page`) A reference to a page nested via the [`RenderShortcodes`] method. [See details](#pageinner-details).
@@ -122,7 +122,7 @@ wrapStandAloneImageWithinParagraph = false
## Default
-{{< new-in 0.123.0 >}}
+{{< new-in 0.123.0 />}}
Hugo includes an [embedded image render hook] to resolve Markdown image destinations. Disabled by default, you can enable it in your site configuration:
diff --git a/content/en/render-hooks/links.md b/content/en/render-hooks/links.md
index 7700a540e..89044c662 100755
--- a/content/en/render-hooks/links.md
+++ b/content/en/render-hooks/links.md
@@ -38,7 +38,7 @@ Link render hook templates receive the following context:
###### PageInner
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
(`page`) A reference to a page nested via the [`RenderShortcodes`] method. [See details](#pageinner-details).
@@ -90,7 +90,7 @@ To include a `rel` attribute set to `external` for external links:
## Default
-{{< new-in 0.123.0 >}}
+{{< new-in 0.123.0 />}}
Hugo includes an [embedded link render hook] to resolve Markdown link destinations. Disabled by default, you can enable it in your site configuration:
diff --git a/content/en/render-hooks/passthrough.md b/content/en/render-hooks/passthrough.md
index 95bc54d88..798225061 100755
--- a/content/en/render-hooks/passthrough.md
+++ b/content/en/render-hooks/passthrough.md
@@ -12,7 +12,7 @@ weight: 80
toc: true
---
-{{< new-in 0.132.0 >}}
+{{< new-in 0.132.0 />}}
## Overview
diff --git a/content/en/render-hooks/tables.md b/content/en/render-hooks/tables.md
index 4252d6de0..d131664fc 100755
--- a/content/en/render-hooks/tables.md
+++ b/content/en/render-hooks/tables.md
@@ -12,7 +12,7 @@ weight: 90
toc: true
---
-{{< new-in 0.134.0 >}}
+{{< new-in 0.134.0 />}}
## Context
diff --git a/content/en/shortcodes/_index.md b/content/en/shortcodes/_index.md
index e525ef5ef..2d9a8fdd6 100644
--- a/content/en/shortcodes/_index.md
+++ b/content/en/shortcodes/_index.md
@@ -1,6 +1,6 @@
---
title: Shortcodes
-linkTitle: In this section
+
description: Insert elements such as videos, images, and social media embeds into your content using Hugo's embedded shortcodes.
categories: []
keywords: []
diff --git a/content/en/shortcodes/comment.md b/content/en/shortcodes/comment.md
index 208277bf5..1600c09d3 100755
--- a/content/en/shortcodes/comment.md
+++ b/content/en/shortcodes/comment.md
@@ -9,7 +9,7 @@ menu:
parent: shortcodes
weight:
weight:
-expiryDate: 2025-01-22 # with v0.142.0 and later use HTML comments instead
+expiryDate: 2025-01-22 # deprecated 2025-02-01 in v0.143.0 and immediately removed from the documentation
---
{{% note %}}
@@ -18,7 +18,7 @@ To override Hugo's embedded `comment` shortcode, copy the [source code] to a fil
[source code]: {{% eturl comment %}}
{{% /note %}}
-{{< new-in "0.137.1" >}}
+{{< new-in 0.137.1 />}}
Use the `comment` shortcode to include comments in your content. Hugo will ignore the text within these comments when rendering your site.
diff --git a/content/en/shortcodes/details.md b/content/en/shortcodes/details.md
index f6e5ae691..f30f81d75 100755
--- a/content/en/shortcodes/details.md
+++ b/content/en/shortcodes/details.md
@@ -11,7 +11,7 @@ weight:
toc: true
---
-{{< new-in 0.140.0 >}}
+{{< new-in 0.140.0 />}}
{{% note %}}
To override Hugo's embedded `details` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
diff --git a/content/en/shortcodes/gist.md b/content/en/shortcodes/gist.md
index dc85f282c..1c740bccb 100755
--- a/content/en/shortcodes/gist.md
+++ b/content/en/shortcodes/gist.md
@@ -8,13 +8,19 @@ menu:
parent: shortcodes
weight:
weight:
+expiryDate: 2027-02-01 # deprecated 2025-02-01 in v0.143.0
---
-{{% note %}}
-To override Hugo's embedded `gist` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+{{% deprecated-in 0.143.0 %}}
+The `gist` shortcode was deprecated in version 0.143.0 and will be removed in a future release. To continue embedding GitHub Gists in your content, you'll need to create a custom shortcode:
-[source code]: {{% eturl gist %}}
-{{% /note %}}
+1. Create a new file: Create a file named `gist.html` within the `layouts/shortcodes` directory.
+2. Copy the source code: Paste the [original source code] of the gist shortcode into the newly created `gist.html` file.
+
+This will allow you to maintain the functionality of embedding GitHub Gists in your content after the deprecation of the original shortcode.
+
+[original source code]: {{% eturl gist %}}
+{{% /deprecated-in %}}
To display a GitHub gist with this URL:
@@ -28,14 +34,8 @@ Include this in your Markdown:
{{}}
```
-This will display all files in the gist alphabetically by file name.
-
-{{< gist jmooring 23932424365401ffa5e9d9810102a477 >}}
-
To display a specific file within the gist:
```text
{{}}
```
-
-{{< gist jmooring 23932424365401ffa5e9d9810102a477 list.html >}}
diff --git a/content/en/shortcodes/param.md b/content/en/shortcodes/param.md
index 70866d4ba..bff659ec1 100755
--- a/content/en/shortcodes/param.md
+++ b/content/en/shortcodes/param.md
@@ -27,7 +27,7 @@ params:
size: medium
---
-We found a {{}} shirt.
+We found a {{%/* param "color" */%}} shirt.
{{< /code >}}
Hugo renders this to:
@@ -39,5 +39,5 @@ Hugo renders this to:
Access nested values by [chaining](g) the [identifiers](g):
```text
-{{}}
+{{%/* param my.nested.param */%}}
```
diff --git a/content/en/shortcodes/qr.md b/content/en/shortcodes/qr.md
index 15e06cbc3..a7a6d92cb 100755
--- a/content/en/shortcodes/qr.md
+++ b/content/en/shortcodes/qr.md
@@ -11,7 +11,7 @@ weight:
toc: true
---
-{{< new-in 0.141.0 >}}
+{{< new-in 0.141.0 />}}
{{% note %}}
To override Hugo's embedded `qr` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
@@ -44,7 +44,7 @@ https://gohugo.io
Both of the above produce this image:
-{{< qr text="https://gohugo.io" class="qrcode" />}}
+{{< qr text="https://gohugo.io" class="qrcode" targetDir="images/qr" />}}
To create a QR code for a phone number:
@@ -52,7 +52,7 @@ To create a QR code for a phone number:
{{}}
```
-{{< qr text="tel:+12065550101" class="qrcode" />}}
+{{< qr text="tel:+12065550101" class="qrcode" targetDir="images/qr" />}}
To create a QR code containing contact information in the [vCard] format:
@@ -72,7 +72,7 @@ END:VCARD
{{}}
```
-{{< qr level="low" scale=2 alt="QR code of vCard for John Smith" class="qrcode" >}}
+{{< qr level="low" scale=2 alt="QR code of vCard for John Smith" class="qrcode" targetDir="images/qr" >}}
BEGIN:VCARD
VERSION:2.1
N;CHARSET=UTF-8:Smith;John;R.;Dr.;PhD
diff --git a/content/en/shortcodes/vimeo.md b/content/en/shortcodes/vimeo.md
index b82ad86d4..5ecdf5d02 100755
--- a/content/en/shortcodes/vimeo.md
+++ b/content/en/shortcodes/vimeo.md
@@ -46,7 +46,7 @@ id
title
: (`string`) The `title` attribute of the `iframe` element.
-If you proivde a `class` or `title` you must use a named parameter for the `id`.
+If you provide a `class` or `title` you must use a named parameter for the `id`.
```text
{{}}
diff --git a/content/en/shortcodes/x.md b/content/en/shortcodes/x.md
index 6995d727f..e27bc996a 100755
--- a/content/en/shortcodes/x.md
+++ b/content/en/shortcodes/x.md
@@ -11,7 +11,7 @@ weight:
toc: true
---
-{{< new-in 0.141.0 >}}
+{{< new-in 0.141.0 />}}
{{% note %}}
To override Hugo's embedded `x` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
diff --git a/content/en/shortcodes/youtube.md b/content/en/shortcodes/youtube.md
index 51e47a0c9..546529500 100755
--- a/content/en/shortcodes/youtube.md
+++ b/content/en/shortcodes/youtube.md
@@ -41,38 +41,38 @@ id
: (`string`) The video `id`. Optional if the `id` is provided as a positional argument as shown in the example above.
allowFullScreen
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`bool`) Whether the `iframe` element can activate full screen mode. Default is `true`.
autoplay
- {{< new-in 0.125.0 >}}
+ {{< new-in 0.125.0 />}}
: (`bool`) Whether to automatically play the video. Forces `mute` to `true`. Default is `false`.
class
: (`string`) The `class` attribute of the wrapping `div` element. When specified, removes the `style` attributes from the `iframe` element and its wrapping `div` element.
controls
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`bool`) Whether to display the video controls. Default is `true`.
end
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`int`) The time, measured in seconds from the start of the video, when the player should stop playing the video.
loading
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`string`) The loading attribute of the `iframe` element, either `eager` or `lazy`. Default is `eager`.
loop
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`bool`) Whether to indefinitely repeat the video. Ignores the `start` and `end` arguments after the first play. Default is `false`.
mute
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`bool`) Whether to mute the video. Always `true` when `autoplay` is `true`. Default is `false`.
start
-{{< new-in 0.125.0 >}}
+{{< new-in 0.125.0 />}}
: (`int`) The time, measured in seconds from the start of the video, when the player should start playing the video.
title
diff --git a/content/en/templates/404.md b/content/en/templates/404.md
index 39df75c3d..ae18428fb 100644
--- a/content/en/templates/404.md
+++ b/content/en/templates/404.md
@@ -38,16 +38,16 @@ Your production server redirects the browser to the 404 page when a page is not
Host|Capabilities and configuration
:--|:--
-Amazon CloudFront|See [details](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GeneratingCustomErrorResponses.html).
-Amazon S3|See [details](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CustomErrorDocSupport.html).
-Apache|See [details](https://httpd.apache.org/docs/2.4/custom-error.html).
-Azure Static Web Apps|See [details](https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#response-overrides).
-Azure Storage|See [details](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website#setting-up-a-static-website).
-Caddy|See [details](https://caddyserver.com/docs/caddyfile/directives/handle_errors).
-Cloudflare Pages|See [details](https://developers.cloudflare.com/pages/configuration/serving-pages/#not-found-behavior).
-DigitalOcean App Platform|See [details](https://docs.digitalocean.com/products/app-platform/how-to/manage-static-sites/#configure-a-static-site).
-Firebase|See [details](https://firebase.google.com/docs/hosting/full-config#404).
+Amazon CloudFront|See [details](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GeneratingCustomErrorResponses.html).
+Amazon S3|See [details](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CustomErrorDocSupport.html).
+Apache|See [details](https://httpd.apache.org/docs/2.4/custom-error.html).
+Azure Static Web Apps|See [details](https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#response-overrides).
+Azure Storage|See [details](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website#setting-up-a-static-website).
+Caddy|See [details](https://caddyserver.com/docs/caddyfile/directives/handle_errors).
+Cloudflare Pages|See [details](https://developers.cloudflare.com/pages/configuration/serving-pages/#not-found-behavior).
+DigitalOcean App Platform|See [details](https://docs.digitalocean.com/products/app-platform/how-to/manage-static-sites/#configure-a-static-site).
+Firebase|See [details](https://firebase.google.com/docs/hosting/full-config#404).
GitHub Pages|Redirection to is automatic and not configurable.
-GitLab Pages|See [details](https://docs.gitlab.com/ee/user/project/pages/introduction.html#custom-error-codes-pages).
-NGINX|See [details](https://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
-Netlify|See [details](https://docs.netlify.com/routing/redirects/redirect-options/).
+GitLab Pages|See [details](https://docs.gitlab.com/ee/user/project/pages/introduction.html#custom-error-codes-pages).
+NGINX|See [details](https://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
+Netlify|See [details](https://docs.netlify.com/routing/redirects/redirect-options/).
diff --git a/content/en/templates/_index.md b/content/en/templates/_index.md
index 0d8f0a0ec..d205c9218 100644
--- a/content/en/templates/_index.md
+++ b/content/en/templates/_index.md
@@ -1,7 +1,7 @@
---
title: Templates
-linkTitle: In this section
-description: Go templating, template types and lookup order, shortcodes, and data.
+
+description: Create templates to render your content, resources, and data.
categories: []
keywords: []
menu:
diff --git a/content/en/templates/embedded.md b/content/en/templates/embedded.md
index 246381db2..2e571256e 100644
--- a/content/en/templates/embedded.md
+++ b/content/en/templates/embedded.md
@@ -34,7 +34,7 @@ To include the embedded template:
{{ template "_internal/disqus.html" . }}
```
-### Configure Disqus
+### Configuration {#configuration-disqus}
To use Hugo's Disqus template, first set up a single configuration value:
@@ -55,6 +55,15 @@ You can also set the following in the front matter for a given piece of content:
- `disqus_title`
- `disqus_url`
+### Privacy {#privacy-disqus}
+
+Adjust the relevant privacy settings in your site configuration.
+
+{{< code-toggle config=privacy.disqus />}}
+
+disable
+: (`bool`) Whether to disable the template. Default is `false`.
+
## Google Analytics
{{% note %}}
@@ -76,7 +85,7 @@ To include the embedded template:
{{ template "_internal/google_analytics.html" . }}
```
-### Configure Google Analytics
+### Configuration {#configuration-google-analytics}
Provide your tracking ID in your configuration file:
@@ -87,6 +96,18 @@ id = "G-MEASUREMENT_ID"
To use this value in your own template, access the configured ID with `{{ site.Config.Services.GoogleAnalytics.ID }}`.
+### Privacy {#privacy-google-analytics}
+
+Adjust the relevant privacy settings in your site configuration.
+
+{{< code-toggle config=privacy.googleAnalytics />}}
+
+disable
+: (`bool`) Whether to disable the template. Default is `false`.
+
+respectDoNotTrack
+: (`bool`) Whether to respect the browser's "do not track" setting. Default is `false`.
+
## Open Graph
{{% note %}}
@@ -107,7 +128,7 @@ To include the embedded template:
{{ template "_internal/opengraph.html" . }}
```
-### Configure Open Graph
+### Configuration {#configuration-open-graph}
Hugo's Open Graph template is configured using a mix of configuration settings and [front matter](/content-management/front-matter/) on individual pages.
@@ -187,7 +208,7 @@ To include the embedded template:
{{ template "_internal/twitter_cards.html" . }}
```
-### Configure X (Twitter) Cards
+### Configuration {#configuration-x-cards}
Hugo's X (Twitter) Card template is configured using a mix of configuration settings and [front-matter](/content-management/front-matter/) values on individual pages.
diff --git a/content/en/templates/home.md b/content/en/templates/home.md
index 088f40f26..18114eb0f 100644
--- a/content/en/templates/home.md
+++ b/content/en/templates/home.md
@@ -1,5 +1,5 @@
---
-title: Home templates
+title: Home page templates
description: The home page of a website is often formatted differently than the other pages. For this reason, Hugo makes it easy for you to define your new site's home page as a unique template.
categories: [templates]
keywords: []
@@ -12,43 +12,53 @@ toc: true
aliases: [/layout/homepage/,/templates/homepage-template/,/templates/homepage/]
---
-The home template is the *only* required template for building a site and therefore useful when bootstrapping a new site and template. It is also the only required template if you are developing a single-page website.
+## Introduction
-{{< youtube ut1xtRZ1QOA >}}
-
-## Home template lookup order
-
-See [Template Lookup](/templates/lookup-order/).
-
-## Add content and front matter to the home page
-
-The home page accepts content and front matter from an `_index.md` file. This file should live at the root of your `content` directory (i.e., `content/_index.md`). You can then add body copy and metadata to your home page the way you would any other content file.
-
-See the home template below or [Content Organization][contentorg] for more information on the role of `_index.md` in adding content and front matter to list pages.
-
-## Example home template
+A home page template is used to render your site's home page, and is the only template required for a single-page website. For example, the home page template below inherits the site's shell from the base template and renders the home page content, such as a list of other pages.
{{< code file=layouts/_default/home.html >}}
{{ define "main" }}
-
-
-
{{ .Title }}
- {{ with .Params.subtitle }}
- {{ . }}
- {{ end }}
-
-
-
- {{ .Content }}
-
-
- {{ range first 10 .Site.RegularPages }}
- {{ .Render "summary" }}
- {{ end }}
-
+ {{ end }}
{{ end }}
{{< /code >}}
-[contentorg]: /content-management/organization/
-[lookup]: /templates/lookup-order/
+{{% include "templates/_common/filter-sort-group.md" %}}
+
+## Lookup order
+
+Hugo's [template lookup order] determines the template path, allowing you to create unique templates for any page.
+
+[template lookup order]: /templates/lookup-order/#home-templates
+
+{{% note %}}
+You must have thorough understanding of the template lookup order when creating templates. Template selection is based on template type, page kind, content type, section, language, and output format.
+{{% /note %}}
+
+## Content and front matter
+
+The home page template uses content and front matter from an `_index.md` file located in the root of your content directory.
+
+{{< code-toggle file=content/_index.md fm=true >}}
+---
+title: The Home Page
+date: 2025-01-30T03:36:57-08:00
+draft: false
+params:
+ subtitle: The Subtitle
+---
+{{< /code-toggle >}}
+
+The home page template below inherits the site's shell from the base template, renders the subtitle and content as defined in the `_index.md` file, then renders of list of the site's [regular pages](g).
+
+{{< code file=layouts/_default/home.html >}}
+{{ define "main" }}
+
{{ .Params.Subtitle }}
+ {{ .Content }}
+ {{ range site.RegularPages }}
+
+ {{ end }}
+{{ end }}
+{{< /code >}}
diff --git a/content/en/templates/output-formats.md b/content/en/templates/output-formats.md
index c81d58488..c81a81264 100644
--- a/content/en/templates/output-formats.md
+++ b/content/en/templates/output-formats.md
@@ -22,7 +22,7 @@ This is the full set of built-in media types in Hugo:
{{< datatable "config" "mediaTypes" "_key" "suffixes" >}}
-**Note:**
+Notes:
- It is possible to add custom media types or change the defaults; e.g., if you want to change the suffix for `text/html` to `asp`.
- `Suffixes` are the values that will be used for URLs and file names for that media type in Hugo.
@@ -41,7 +41,7 @@ To add or modify a media type, define it in a `mediaTypes` section in your [site
The above example adds one new media type, `text/enriched`, and changes the suffix for the built-in `text/html` media type.
-**Note:** these media types are configured for **your output formats**. If you want to redefine one of Hugo's default output formats (e.g. `HTML`), you also need to redefine the media type. So, if you want to change the suffix of the `HTML` output format from `html` (default) to `htm`:
+These media types are configured for your output formats. If you want to redefine one of Hugo's default output formats, you also need to redefine the media type. So, if you want to change the suffix of the `HTML` output format from `html` (default) to `htm`:
{{< code-toggle file=hugo >}}
[mediaTypes]
@@ -65,7 +65,8 @@ This is the full set of Hugo's built-in output formats:
{{< datatable "config" "outputFormats" "_key" "baseName" "isHTML" "isPlainText" "mediaType" "noUgly" "path" "permalinkable" "protocol" "rel" >}}
-- A page can be output in as many output formats as you want, and you can have an infinite amount of output formats defined **as long as they resolve to a unique path on the file system**. In the above table, the best example of this is `amp` vs. `html`. `amp` has the value `amp` for `path` so it doesn't overwrite the `html` version; e.g. we can now have both `/index.html` and `/amp/index.html`.
+- A page can be output in as many output formats as you want, and you can have an infinite amount of output formats defined as long as they resolve to a unique path on the file system. In the above table, the best example of this is `amp` vs. `html`. `amp` has the value `amp` for `path` so it doesn't overwrite the `html` version; e.g. we can now have both `/index.html` and `/amp/index.html`.
+
- The `mediaType` must match a defined media type.
- You can define new output formats or redefine built-in output formats; e.g., if you want to put `amp` pages in a different path.
@@ -89,10 +90,10 @@ baseName
: (`string`) The base name of the published file. Default is `index`.
isHTML
-: (`bool`) If `true`, classifies the output format as HTML. Hugo uses this value to determine when to create alias redirects, when to inject the LiveReload script, etc. Default is `false`.
+: (`bool`) Whether to classify the output format as HTML. Hugo uses this value to determine when to create alias redirects, when to inject the LiveReload script, etc. Default is `false`.
isPlainText
-: (`bool`) If `true`, Hugo parses templates for this output format with Go's [text/template] package instead of the [html/template] package. Default is `false`.
+: (`bool`) Whether to parse templates for this output format with Go's [text/template] package instead of the [html/template] package. Default is `false`.
[html/template]: https://pkg.go.dev/html/template
[text/template]: https://pkg.go.dev/text/template
@@ -103,12 +104,12 @@ mediaType
[media type]: https://en.wikipedia.org/wiki/Media_type
notAlternative
-: (`bool`) If `true`, excludes this output format from the values returned by the [`AlternativeOutputFormats`] method on a `Page` object. Default is `false`.
+: (`bool`) Whether to exclude this output format from the values returned by the [`AlternativeOutputFormats`] method on a `Page` object. Default is `false`.
[`AlternativeOutputFormats`]: /methods/page/alternativeoutputformats/
noUgly
-: (`bool`) If `true`, disables ugly URLs for this output format when `uglyURLs` is `true` in your site configuration. Default is `false`.
+: (`bool`) Whether to disable ugly URLs for this output format when `uglyURLs` is `true` in your site configuration. Default is `false`.
path
: (`string`) The path to the directory containing the published files, relative to the root of the publish directory.
@@ -126,10 +127,10 @@ rel
: (`string`) If provided, you can assign this value to `rel` attributes in `link` elements when iterating over output formats in your templates. Default is `alternate`.
root
-: (`bool`) If `true`, files will be published to the root of the publish directory. Default is `false`.
+: (`bool`) Whether to publish files to the root of the publish directory. Default is `false`.
ugly
-: (`bool`) If `true`, enables uglyURLs for this output format when `uglyURLs` is `false` in your site configuration. Default is `false`.
+: (`bool`) Whether to enable uglyURLs for this output format when `uglyURLs` is `false` in your site configuration. Default is `false`.
weight
: (`int`) When set to a non-zero value, Hugo uses the `weight` as the first criteria when sorting output formats, falling back to the name of the output format. Lighter items float to the top, while heavier items sink to the bottom. Hugo renders output formats sequentially based on the sort order.
@@ -160,11 +161,11 @@ Example from site configuration file:
page = ["html"]
{{}}
-Note that in the above examples, the _output formats_ for `section`,
+Note that in the examples above, the output formats for `section`,
`taxonomy` and `term` will stay at their default value `['html','rss']`.
-* The `outputs` definition is per page [`Kind`].
-* The names (e.g. `html`, `amp`) must match the `name` of a defined output format, and can be overridden per page in front matter.
+- The `outputs` definition is per page [`Kind`].
+- The names (e.g. `html`, `amp`) must match the `name` of a defined output format, and can be overridden per page in front matter.
The following is an example of front matter in a content file that defines output formats for the rendered `Page`:
@@ -196,7 +197,8 @@ The [`Permalink`] and [`RelPermalink`] methods on a `Page` object return the fir
[`Permalink`]: /methods/page/permalink
[`RelPermalink`]: /methods/page/relpermalink
-__from `single.json.json`:__
+From `single.json.json`:
+
```go-html-template
{{ .RelPermalink }} → /that-page/
{{ with .OutputFormats.Get "json" }}
@@ -206,7 +208,7 @@ __from `single.json.json`:__
In order for them to return the output format of the current template file instead, the given output format should have its `permalinkable` setting set to true.
-**Same template file as above with json output format's `permalinkable` set to true:**
+This is the same template file as above with the `json` output format's `permalinkable` parameter set to `true`:
```go-html-template
{{ .RelPermalink }} → /that-page/index.json
@@ -215,34 +217,25 @@ In order for them to return the output format of the current template file inste
{{ end }}
```
-From content files, you can use the `ref` or `relref` shortcodes:
+## Template lookup order
-```go-html-template
-[Neat]({{}})
-[Who]({{}})
+Each output format requires a template conforming to the [template lookup order].
+
+For the highest specificity in the template lookup order, include the page kind, output format, and suffix in the file name:
+
+[template lookup order]: /templates/lookup-order/
+
+```text
+[page kind].[output format].[suffix]
```
-## Templates for your output formats
+For example, for section pages:
-Each output format requires a corresponding template conforming to the [template lookup order](/templates/lookup-order/). Hugo considers both output format and suffix when selecting a template.
-
-For example, to generate a JSON file for the home page, the template with highest specificity is `layouts/index.json.json`.
-
-Hugo will now also detect the media type and output format of partials, if possible, and use that information to decide if the partial should be parsed as a plain text template or not.
-
-Hugo will look for the name given, so you can name it whatever you want. But if you want it treated as plain text, you should use the file suffix and, if needed, the name of the Output Format. The pattern is as follows:
-
-```go-html-template
-[partial name].[OutputFormat].[suffix]
-```
-
-The partial below is a plain text template . The output format is `csv`, and since this is the only output format with the suffix `csv`, we don't need to include the output format `name`):
-
-```go-html-template
-{{ partial "mytextpartial.csv" . }}
-```
+Output format|Template path
+:--|:--
+`html`|`layouts/_default/section.html.html`
+`json`|`layouts/_default/section.json.json`
+`rss`|`layouts/_default/section.rss.xml`
[site configuration]: /getting-started/configuration/
-[lookup order]: /templates/lookup-order/
-[media type]: https://en.wikipedia.org/wiki/Media_type
[`kind`]: /methods/page/kind/
diff --git a/content/en/templates/section.md b/content/en/templates/section.md
index 28d931534..339fe6389 100644
--- a/content/en/templates/section.md
+++ b/content/en/templates/section.md
@@ -1,6 +1,6 @@
---
title: Section templates
-description: Use section templates to list members of a section.
+description: Create a section template to list its members.
categories: [templates]
keywords: []
menu:
diff --git a/content/en/templates/shortcode.md b/content/en/templates/shortcode.md
index 452aeda59..c73874673 100644
--- a/content/en/templates/shortcode.md
+++ b/content/en/templates/shortcode.md
@@ -1,7 +1,6 @@
---
-title: Create your own shortcodes
-linkTitle: Shortcode templates
-description: You can extend Hugo's embedded shortcodes by creating your own using the same templating syntax as that for single and list pages.
+title: Shortcode templates
+description: Create custom shortcodes to simplify and standardize content creation.
categories: [templates]
keywords: []
menu:
@@ -13,31 +12,54 @@ aliases: [/templates/shortcode-templates/]
toc: true
---
-Shortcodes are a means to consolidate templating into small, reusable snippets that you can embed directly inside your content.
-
{{% note %}}
-Hugo also ships with embedded shortcodes for common use cases. (See [Content Management: Shortcodes](/content-management/shortcodes/).)
+Before creating custom shortcodes, please review the [shortcodes] page in the [content management] section. Understanding the usage details will help you design and create better templates.
+
+[shortcodes]: /content-management/shortcodes/
+[content management]: /content-management/shortcodes/
{{% /note %}}
-## Create custom shortcodes
+## Introduction
-Hugo's embedded shortcodes cover many common, but not all, use cases. Luckily, Hugo provides the ability to easily create custom shortcodes to meet your website's needs.
+Hugo provides [embedded shortcodes] for many common tasks, but you'll likely need to create your own for more specific needs. Some examples of custom shortcodes you might develop include:
-{{< youtube Eu4zSaKOY4A >}}
+- Audio players
+- Video players
+- Image galleries
+- Diagrams
+- Maps
+- Tables
+- And many other custom elements
-### File location
+[embedded shortcodes]: /shortcodes/
-To create a shortcode, place an HTML template in the `layouts/shortcodes` directory. Consider the file name carefully since the shortcode name will mirror that of the file but without the `.html` extension. For example, `layouts/shortcodes/myshortcode.html` will be called with either `{{}}` or `{{%/* myshortcode /*/%}}`.
+## Directory structure
-You can organize your shortcodes in subdirectories, e.g. in `layouts/shortcodes/boxes`. These shortcodes would then be accessible with their relative path, e.g:
+Create shortcode templates within the `layouts/shortcodes` directory, either at its root or organized into subdirectories.
-```go-html-template
-{{}}
+```text
+layouts/
+└── shortcodes/
+ ├── diagrams/
+ │ ├── kroki.html
+ │ └── plotly.html
+ ├── media/
+ │ ├── audio.html
+ │ ├── gallery.html
+ │ └── video.html
+ ├── capture.html
+ ├── column.html
+ ├── include.html
+ └── row.html
```
-Note the forward slash.
+When calling a shortcode in a subdirectory, specify its path relative to the `shortcode` directory, excluding the file extension.
-### Template lookup order
+```text
+{{}}
+```
+
+## Lookup order
Hugo selects shortcode templates based on the shortcode name, the current output format, and the current language. The examples below are sorted by specificity in descending order. The least specific path is at the bottom of the list.
@@ -50,277 +72,225 @@ foo|html|en|`layouts/shortcodes/foo.html.en.html`
Shortcode name|Output format|Language|Template path
:--|:--|:--|:--
-foo|rss|en|`layouts/shortcodes/foo.en.xml`
-foo|rss|en|`layouts/shortcodes/foo.rss.xml`
-foo|rss|en|`layouts/shortcodes/foo.en.html`
-foo|rss|en|`layouts/shortcodes/foo.rss.en.xml`
-foo|rss|en|`layouts/shortcodes/foo.xml`
-foo|rss|en|`layouts/shortcodes/foo.html.en.html`
-foo|rss|en|`layouts/shortcodes/foo.html.html`
-foo|rss|en|`layouts/shortcodes/foo.html`
+foo|json|en|`layouts/shortcodes/foo.en.json`
+foo|json|en|`layouts/shortcodes/foo.json`
+foo|json|en|`layouts/shortcodes/foo.json.json`
+foo|json|en|`layouts/shortcodes/foo.json.en.json`
-Note that templates provided by a theme or module always take precedence.
+## Methods
-### Positional vs. named arguments
+Use these methods in your shortcode templates. Refer to each methods's documentation for details and examples.
-You can create shortcodes using the following types of arguments:
+{{< list-pages-in-section path=/methods/shortcode >}}
-* Positional arguments
-* Named arguments
-* Positional *or* named arguments
+## Examples
-In shortcodes with positional arguments, the order of the arguments is important. If a shortcode has a single required value, positional arguments require less typing from content authors.
+These examples range in complexity from simple to moderately advanced, with some simplified for clarity.
-For more complex layouts with multiple or optional arguments, named arguments work best. While less terse, named arguments require less memorization from a content author and can be added in a shortcode declaration in any order.
+### Insert year
-Allowing both types of arguments is useful for complex layouts where you want to set default values that can be easily overridden by users.
-
-### Access arguments
-
-All shortcode arguments can be accessed via the `.Get` method. Whether you pass a string or a number to the `.Get` method depends on whether you are accessing a named or positional argument, respectively.
-
-To access an argument by name, use the `.Get` method followed by the named argument as a quoted string:
-
-```go-html-template
-{{ .Get "class" }}
-```
-
-To access an argument by position, use the `.Get` followed by a numeric position, keeping in mind that positional arguments are zero-indexed:
-
-```go-html-template
-{{ .Get 0 }}
-```
-
-For the second position, you would just use:
-
-```go-html-template
-{{ .Get 1 }}
-```
-
-`with` is great when the output depends on a argument being set:
-
-```go-html-template
-{{ with .Get "class" }} class="{{ . }}"{{ end }}
-```
-
-`.Get` can also be used to check if a argument has been provided. This is
-most helpful when the condition depends on either of the values, or both:
-
-```go-html-template
-{{ if or (.Get "title") (.Get "alt") }} alt="{{ with .Get "alt" }}{{ . }}{{ else }}{{ .Get "title" }}{{ end }}"{{ end }}
-```
-
-#### `.Inner`
-
-The `.Inner` method returns the content between the opening and closing shortcode tags. To check if `.Inner` returns anything other than whitespace:
-
-```go-html-template
-{{ if strings.ContainsNonSpace .Inner }}
- Inner is not empty
-{{ end }}
-```
-
-{{% note %}}
-Any shortcode that calls the `.Inner` method must be closed or self-closed. To call a shortcode using the self-closing syntax.
-
-```go-html-template
-{{}}
-```
-
-{{% /note %}}
-
-#### `.Params`
-
-The `.Params` method in shortcodes returns the arguments passed to the shortcode for more complicated use cases. You can also access higher-scoped arguments with the following logic:
-
-$.Params
-: these are the arguments passed directly into the shortcode declaration (e.g., a YouTube video ID)
-
-$.Page.Params
-: refers to the page's parameters; the "page" in this case refers to the content file in which the shortcode is declared (e.g., a `shortcode_color` field in a content's front matter could be accessed via `$.Page.Params.shortcode_color`).
-
-$.Site.Params
-: refers to parameters defined in your site configuration.
-
-#### `.IsNamedParams`
-
-The `.IsNamedParams` method checks whether the shortcode declaration uses named arguments and returns a boolean value.
-
-For example, you could create an `image` shortcode that can take either a `src` named argument or the first positional argument, depending on the preference of the content's author. Let's assume the `image` shortcode is called as follows:
-
-```go-html-template
-{{}}
-```
-
-You could then include the following as part of your shortcode templating:
-
-```go-html-template
-{{ if .IsNamedParams }}
-
-{{ else }}
-
-{{ end }}
-```
-
-See the [example Vimeo shortcode][vimeoexample] below for `.IsNamedParams` in action.
-
-{{% note %}}
-While you can create shortcode templates that accept both positional and named arguments, you *cannot* declare shortcodes in content with a mix of argument types. Therefore, a shortcode declared like `{{}}` will return an error.
-{{% /note %}}
-
-Shortcodes can also be nested. In a nested shortcode, you can access the parent shortcode context with the [`.Parent`] shortcode method. This can be very useful for inheritance from the root.
-
-### Checking for existence
-
-You can check if a specific shortcode is used on a page by calling `.HasShortcode` in that page template, providing the name of the shortcode. This is useful when you want to include specific scripts or styles in the header that are only used by that shortcode.
-
-## Custom shortcode examples
-
-The following are examples of the different types of shortcodes you can create via shortcode template files in `/layouts/shortcodes`.
-
-### Single-word example: `year`
-
-Let's assume you would like to keep mentions of your copyright year current in your content files without having to continually review your Markdown. Your goal is to be able to call the shortcode as follows:
-
-```go-html-template
-{{}}
-```
+Create a shortcode to insert the current year:
{{< code file=layouts/shortcodes/year.html >}}
-{{ now.Format "2006" }}
+{{- now.Format "2006" -}}
{{< /code >}}
-### Single positional example: `youtube`
+Then call the shortcode from within your markup:
-Embedded videos are a common addition to Markdown content. The following is the code used by [Hugo's built-in YouTube shortcode][youtubeshortcode]:
+{{< code file=content/example.md >}}
+This is {{}}, and look at how far we've come.
+{{< /code >}}
-```go-html-template
-{{}}
+This shortcode can be used inline or as a block on its own line. If a shortcode might be used inline, remove the surrounding [whitespace] by using [template action](g) delimiters with hyphens.
+
+[whitespace]: /templates/introduction/#whitespace
+
+### Insert image
+
+This example assumes the following content structure, where `content/example/index.md` is a [page bundle](g) containing one or more [page resources](g).
+
+```text
+content/
+├── example/
+│ ├── a.jpg
+│ └── index.md
+└── _index.md
```
-Would load the template at `/layouts/shortcodes/youtube.html`:
+Create a shortcode to capture an image as a page resource, resize it to the given width, convert it to the WebP format, and add an `alt` attribute:
-{{< code file=layouts/shortcodes/youtube.html >}}
-
-
-
+{{< code file=layouts/shortcodes/image.html >}}
+{{- with .Page.Resources.Get (.Get "path") }}
+ {{- with .Process (printf "resize %dx wepb" ($.Get "width")) }}
+
+ {{- end }}
+{{- end -}}
{{< /code >}}
-{{< code file=youtube-embed.html >}}
-
-
-
+Then call the shortcode from within your markup:
+
+{{< code file=content/example/index.md >}}
+{{}}
{{< /code >}}
-### Single named example: `image`
+The example above uses:
-Let's say you want to create your own `img` shortcode rather than use Hugo's built-in [`figure` shortcode][figure]. Your goal is to be able to call the shortcode as follows in your content files:
+- The [`with`] statement to rebind the [context](g) after each successful operation
+- The [`Get`] method to retrieve arguments by name
+- The `$` to access the template context
-{{< code file=content-image.md >}}
-{{}}
+[`get`]: /methods/shortcode/get/
+[`with`]: /functions/go-template/with/
+
+{{% note %}}
+Make sure that you thoroughly understand the concept of context. The most common templating errors made by new users relate to context.
+
+Read more about context in the [introduction to templating].
+
+[introduction to templating]: /templates/introduction/
+{{% /note %}}
+
+### Insert image with error handling
+
+The previous example, while functional, silently fails if the image is missing, and does not gracefully exit if a required argument is missing. We'll add error handling to address these issues:
+
+{{< code file=layouts/shortcodes/image.html >}}
+{{ with .Get "path" }}
+ {{- with $r := $.Page.Resources.Get ($.Get "path") }}
+ {{- with $.Get "width" }}
+ {{- with $r.Process (printf "resize %dx wepb" ($.Get "width" )) }}
+ {{- $alt := or ($.Get "alt") "" }}
+
+ {{- end }}
+ {{- else }}
+ {{- errorf "The %q shortcode requires a 'width' argument: see %s" $.Name $.Position }}
+ {{- end }}
+ {{- else }}
+ {{ warnf "The %q shortcode was unable to find %s: see %s" $.Name ($.Get "path") $.Position }}
+ {{- end }}
+{{- else }}
+ {{ errorf "The %q shortcode requires a 'path' argument: see %s" .Name .Position }}
+{{- end -}}
{{< /code >}}
-You have created the shortcode at `/layouts/shortcodes/img.html`, which loads the following shortcode template:
+This template throws an error and gracefully fails the build if the author neglected to provide a `path` or `width` argument, and it emits a warning if it cannot find the image at the specified path. If the author does not provide an `alt` argument, the `alt` attribute is set to an empty string.
-{{< code file=layouts/shortcodes/img.html >}}
-
-
- {{ with .Get "link" }}{{ end }}
-
- {{ if .Get "link" }}{{ end }}
- {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr") }}
- {{ if isset .Params "title" }}
-
{{ .Get "title" }}
{{ end }}
- {{ if or (.Get "caption") (.Get "attr") }}
{{ end }}
-
- {{ end }}
-
-
-{{< /code >}}
+The [`Name`] and [`Position`] methods provide helpful context for errors and warnings. For example, a missing `width` argument causes the shortcode to throw this error:
-Would be rendered as:
+[`name`]: /methods/shortcode/name/
+[`position`]: /methods/shortcode/position/
-{{< code file=img-output.html >}}
-
-
-
-
Steve Francia
-
-
-{{< /code >}}
-
-### Single flexible example: `vimeo`
-
-```go-html-template
-{{}}
-{{}}
+```text
+ERROR The "image" shortcode requires a 'width' argument: see "/home/user/project/content/example/index.md:7:1"
```
-Would load the template found at `/layouts/shortcodes/vimeo.html`:
+### Positional arguments
-{{< code file=layouts/shortcodes/vimeo.html >}}
-{{ if .IsNamedParams }}
-
-
-
-{{ else }}
-
-
-
-{{ end }}
+Shortcode arguments can be [named or positional]. We used named arguments previously; let's explore positional arguments. Here's the named argument version of our example:
+
+[named or positional]: /content-management/shortcodes/#arguments
+
+{{< code file=content/example/index.md >}}
+{{}}
{{< /code >}}
-Would be rendered as:
+Here's how to call it with positional arguments:
-{{< code file=vimeo-iframes.html >}}
-
-
-
-
-
+{{< code file=content/example/index.md >}}
+{{}}
+{{< /code >}}
+
+Using the `Get` method with zero-indexed keys, we'll initialize variables with descriptive names in our template:
+
+{{< code file=layouts/shortcodes/image.html >}}
+{{- $path := .Get 0 }}
+{{- $width := .Get 1 }}
+{{- $alt := .Get 2 }}
+{{< /code >}}
+
+{{% note %}}
+Positional arguments work well for frequently used shortcodes with one or two arguments. Since you'll use them often, the argument order will be easy to remember. For less frequently used shortcodes, or those with more than two arguments, named arguments improve readability and reduce the chance of errors.
+{{% /note %}}
+
+### Named and positional arguments
+
+You can create a shortcode that will accept both named and positional arguments, but not at the same time. Use the [`IsNamedParams`] method to determine whether the shortcode call used named or positional arguments:
+
+{{< code file=layouts/shortcodes/image.html >}}
+{{- $path := cond (.IsNamedParams) (.Get "path") (.Get 0) }}
+{{- $width := cond (.IsNamedParams) (.Get "width") (.Get 1) }}
+{{- $alt := cond (.IsNamedParams) (.Get "alt") (.Get 2) }}
+{{< /code >}}
+
+This example uses the `cond` alias for the [`compare.Conditional`] function to get the argument by name if `IsNamedParams` returns `true`, otherwise get the argument by position.
+
+[`compare.Conditional`]: /functions/compare/conditional/
+[`IsNamedParams`]: /methods/shortcode/isnamedparams/
+
+### Argument collection
+
+Use the [`Params`] method to access the arguments as a collection.
+
+[`Params`]: /methods/shortcode/params/
+
+When using named arguments, the `Params` method returns a map:
+
+{{< code file=content/example/index.md >}}
+{{}}
+{{< /code >}}
+
+{{< code file=layouts/shortcodes/image.html >}}
+{{- .Params.path }} → a.jpg
+{{- .Params.width }} → 300
+{{- .Params.alt }} → A white kitten
+{{< /code >}}
+
+ When using positional arguments, the `Params` method returns a slice:
+
+{{< code file=content/example/index.md >}}
+{{}}
+{{< /code >}}
+
+{{< code file=layouts/shortcodes/image.html >}}
+{{- index .Params 0 }} → a.jpg
+{{- index .Params 1 }} → 300
+{{- index .Params 1 }} → A white kitten
+{{< /code >}}
+
+Combine the `Params` method with the [`collections.IsSet`] function to determine if a parameter is set, even if its value is falsy.
+
+[`collections.IsSet`]: /functions/collections/isset/
+
+### Inner content
+
+Extract the content enclosed within shortcode tags using the [`Inner`] method. This example demonstrates how to pass both content and a title to a shortcode. The shortcode then generates a `div` element containing an `h2` element (displaying the title) and the provided content.
+
+[`Inner`]: /methods/shortcode/inner/
+
+{{< code file=content/example.md >}}
+{{}}
+This is a **bold** word, and this is an _emphasized_ word.
+{{}}
+{{< /code >}}
+
+{{< code file=layouts/shortcodes/contrived.html >}}
+
+
{{ .Get "title" }}
+ {{ .Inner | .Page.RenderString }}
{{< /code >}}
-### Paired example: `highlight`
+The preceding example called the shortcode using [standard notation], requiring us to process the inner content with the [`RenderString`] method to convert the Markdown to HTML. This conversion is unnecessary when calling a shortcode using [Markdown notation].
-The following is taken from `highlight`, which is a [built-in shortcode] that ships with Hugo.
+[`RenderString`]: /methods/page/renderstring/
+[markdown notation]: /content-management/shortcodes/#markdown-notation
+[standard notation]: /content-management/shortcodes/#standard-notation
-{{< code file=highlight-example.md >}}
-{{}}
-
- This HTML
-
-{{}}
-{{< /code >}}
+### Nesting
-The template for the `highlight` shortcode uses the following code, which is already included in Hugo:
+The [`Parent`] method provides access to the parent shortcode context when the shortcode in question is called within the context of a parent shortcode. This provides an inheritance model.
-```go-html-template
-{{ .Get 0 | highlight .Inner }}
-```
-
-The rendered output of the HTML example code block will be as follows:
-
-{{< code file=syntax-highlighted.html >}}
-
<html>
- <body> This HTML </body>
-</html>
-
-{{< /code >}}
-
-### Nested shortcode: image gallery
-
-Hugo's [`.Parent`] shortcode method provides access to the parent shortcode context when the shortcode in question is called within the context of a parent shortcode. This provides an inheritance model.
+[`Parent`]: /methods/shortcode/parent/
The following example is contrived but demonstrates the concept. Assume you have a `gallery` shortcode that expects one named `class` argument:
@@ -333,23 +303,24 @@ The following example is contrived but demonstrates the concept. Assume you have
You also have an `img` shortcode with a single named `src` argument that you want to call inside of `gallery` and other shortcodes, so that the parent defines the context of each `img`:
{{< code file=layouts/shortcodes/img.html >}}
-{{- $src := .Get "src" -}}
-{{- with .Parent -}}
+{{ $src := .Get "src" }}
+{{ with .Parent }}
-{{- else -}}
+{{ else }}
-{{- end -}}
+{{ end }}
{{< /code >}}
You can then call your shortcode in your content as follows:
-```go-html-template
+{{< code file=content/example.md >}}
{{}}
{{}}
{{}}
{{}}
{{}}
-```
+{{< /code >}}
+
This will output the following HTML. Note how the first two `img` shortcodes inherit the `class` value of `content-gallery` set with the call to the parent `gallery`, whereas the third `img` only uses `src`:
@@ -361,62 +332,30 @@ This will output the following HTML. Note how the first two `img` shortcodes inh
```
-## Error handling in shortcodes
+### Other examples
-Use the [`errorf`] template function with the [`Name`] and [`Position`] shortcode methods to generate useful error messages:
+For guidance, consider examining Hugo's embedded shortcodes. The source code, available on [GitHub], can provide a useful model.
-{{< code file=layouts/shortcodes/greeting.html >}}
-{{ with .Get "name" }}
-
Hello, my name is {{ . }}.
-{{ else }}
- {{ errorf "The %q shortcode requires a 'name' argument. See %s" .Name .Position }}
-{{ end }}
+[GitHub]: https://github.com/gohugoio/hugo/tree/master/tpl/tplimpl/embedded/templates/shortcodes
+
+## Detection
+
+The [`HasShortcode`] method allows you to check if a specific shortcode has been called on a page. For example, consider a custom audio shortcode:
+
+{{< code file=content/example.md >}}
+{{}}
{{< /code >}}
-When the above fails, you will see an `ERROR` message such as:
+You can use the `HasShortcode` method in your base template to conditionally load CSS if the audio shortcode was used on the page:
-```sh
-ERROR The "greeting" shortcode requires a 'name' argument. See "/home/user/project/content/_index.md:12:1"
-```
+{{< code file=layouts/_default/baseof.html >}}
+
+ ...
+ {{ if .HasShortcode "audio" }}
+
+ {{ end }}
+ ...
+
+{{< /code >}}
-## Inline shortcodes
-
-You can also implement your shortcodes inline -- e.g. where you use them in the content file. This can be useful for scripting that you only need in one place.
-
-This feature is disabled by default, but can be enabled in your site configuration:
-
-{{< code-toggle file=hugo >}}
-[security]
-enableInlineShortcodes = true
-{{< /code-toggle >}}
-
-It is disabled by default for security reasons. The security model used by Hugo's template handling assumes that template authors are trusted, but that the content files are not, so the templates are injection-safe from malformed input data. But in most situations you have full control over the content, too, and then `enableInlineShortcodes = true` would be considered safe. But it's something to be aware of: It allows ad-hoc [Go Text templates](https://golang.org/pkg/text/template/) to be executed from the content files.
-
-And once enabled, you can do this in your content files:
-
- ```go-html-template
- {{}}{{ now }}{{}}
- ```
-
-The above will print the current date and time.
-
-Note that an inline shortcode's inner content is parsed and executed as a Go text template with the same context as a regular shortcode template.
-
-This means that the current page can be accessed via `.Page.Title` etc. This also means that there are no concept of "nested inline shortcodes".
-
-The same inline shortcode can be reused later in the same content file, with different arguments if needed, using the self-closing syntax:
-
- ```go-html-template
-{{}}
-```
-
-[`.Parent`]: /methods/shortcode/parent/
-[`errorf`]: /functions/fmt/errorf/
-[`Name`]: /methods/shortcode/name/
-[`Position`]: /methods/shortcode/position/
-[built-in shortcode]: /content-management/shortcodes/
-[figure]: /shortcodes/figure/
-[lookup order]: /templates/lookup-order/
-[source organization]: /getting-started/directory-structure/
-[vimeoexample]: #single-flexible-example-vimeo
-[youtubeshortcode]: /shortcodes/youtube/
+[`HasShortcode`]: /methods/page/hasshortcode/
diff --git a/content/en/templates/sitemap.md b/content/en/templates/sitemap.md
index 166f54933..b21372040 100644
--- a/content/en/templates/sitemap.md
+++ b/content/en/templates/sitemap.md
@@ -33,16 +33,16 @@ These are the default sitemap configuration values. They apply to all pages unle
{{< code-toggle config=sitemap />}}
changefreq
-: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
+: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
-disable {{< new-in 0.125.0 >}}
+disable {{< new-in 0.125.0 />}}
: (`bool`) Whether to disable page inclusion. Default is `false`. Set to `true` in front matter to exclude the page.
filename
: (`string`) The name of the generated file. Default is `sitemap.xml`.
priority
-: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
+: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
## Override default values
diff --git a/content/en/templates/types/index.md b/content/en/templates/types/index.md
index 0bd72ccc4..8369917bf 100644
--- a/content/en/templates/types/index.md
+++ b/content/en/templates/types/index.md
@@ -48,9 +48,7 @@ Hugo's [template lookup order] determines the template path, allowing you to cre
[template lookup order]: /templates/lookup-order/
{{% note %}}
-You must have thorough understanding of the [template lookup order] when creating templates. Template selection is based on template type, page kind, content type, section, language, and output format.
-
-[template lookup order]: /templates/lookup-order/
+You must have thorough understanding of the template lookup order when creating templates. Template selection is based on template type, page kind, content type, section, language, and output format.
{{% /note %}}
The purpose of each template type is described below.
@@ -88,9 +86,7 @@ Learn more about [base templates](/templates/base/).
## Home
-A home template renders your site's home page. For a single page site this is the only required template.
-
-For example, the home template below inherits the site's shell from the base template, and renders the home page content with a list of pages.
+A home page template is used to render your site's home page, and is the only template required for a single-page website. For example, the home page template below inherits the site's shell from the base template and renders the home page content, such as a list of other pages.
{{< code file=layouts/_default/home.html >}}
{{ define "main" }}
@@ -103,7 +99,7 @@ For example, the home template below inherits the site's shell from the base tem
{{% include "templates/_common/filter-sort-group.md" %}}
-Learn more about [home templates](/templates/home/).
+Learn more about [home page templates](/templates/home/).
## Single
@@ -241,7 +237,7 @@ For example, the render hook template below adds a `rel` attribute to external l
{{- with .Title }} title="{{ . }}"{{ end -}}
{{- if $u.IsAbs }} rel="external"{{ end -}}
>
- {{- with .Text | safeHTML }}{{ . }}{{ end -}}
+ {{- with .Text }}{{ . }}{{ end -}}
{{- /* chomp trailing newline */ -}}
{{< /code >}}
@@ -260,10 +256,10 @@ For example, the shortcode template below renders an audio element from a [globa
{{ end }}
{{< /code >}}
-Call the shortcode from your content page:
+Then call the shortcode from within markup:
{{< code file=content/example.md >}}
-{{}}
+{{}}
{{< /code >}}
Learn more about [shortcode templates](/templates/shortcode/).
diff --git a/content/en/tools/_index.md b/content/en/tools/_index.md
index 9cd72853a..a4df23800 100644
--- a/content/en/tools/_index.md
+++ b/content/en/tools/_index.md
@@ -1,7 +1,7 @@
---
title: Developer tools
-linkTitle: In this section
-description: In addition to Hugo's powerful CLI, there is a large number of community-developed tool chains for Hugo developers.
+
+description: Third-party tools to help you create and manage sites.
categories: []
keywords: []
menu:
diff --git a/content/en/tools/search.md b/content/en/tools/search.md
index 73aea7ce4..152774304 100644
--- a/content/en/tools/search.md
+++ b/content/en/tools/search.md
@@ -29,7 +29,7 @@ A static website with a dynamic search function? Yes, Hugo provides an alternati
: A bit like Hugo-lunr, but Hugo-lunr-zh can help you separate the Chinese keywords.
[GitHub Gist for Fuse.js integration](https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae)
-: This gist demonstrates how to leverage Hugo's existing build time processing to generate a searchable JSON index used by [Fuse.js](https://fusejs.io/) on the client-side. Although this gist uses Fuse.js for fuzzy matching, any client-side search tool capable of reading JSON indexes will work. Does not require npm, grunt, or other build-time tools except Hugo!
+: This gist demonstrates how to leverage Hugo's existing build time processing to generate a searchable JSON index used by [Fuse.js](https://fusejs.io/) on the client side. Although this gist uses Fuse.js for fuzzy matching, any client-side search tool capable of reading JSON indexes will work. Does not require npm, grunt, or other build-time tools except Hugo!
[hugo-search-index](https://www.npmjs.com/package/hugo-search-index)
: A library containing Gulp tasks and a prebuilt browser script that implements search. Gulp generates a search index from project Markdown files.
diff --git a/content/en/troubleshooting/_index.md b/content/en/troubleshooting/_index.md
index 92ba6bc6d..a113fa9cf 100644
--- a/content/en/troubleshooting/_index.md
+++ b/content/en/troubleshooting/_index.md
@@ -1,6 +1,6 @@
---
title: Troubleshooting
-linkTitle: In this section
+
description: Use these techniques when troubleshooting your site.
categories: []
keywords: []
diff --git a/content/en/troubleshooting/deprecation.md b/content/en/troubleshooting/deprecation.md
index 81f2724a3..5dd9f3fa6 100644
--- a/content/en/troubleshooting/deprecation.md
+++ b/content/en/troubleshooting/deprecation.md
@@ -29,10 +29,16 @@ Common [reasons for deprecation]:
After the project team deprecates something in code, Hugo will:
-1. Log an INFO message for 6 minor releases[^1]
-1. Log a WARN message for another 6 minor releases
+1. Log an INFO message for 3 minor releases[^1]
+1. Log a WARN message for another 12 minor releases
1. Log an ERROR message and fail the build thereafter
+The project team will:
+
+1. On the deprecation date, update the documentation with a note describing the deprecation and any relevant alternatives.
+1. Remove the code six or more minor releases after Hugo begins logging ERROR messages and failing the build. At that point, Hugo will throw an error, but the error message will no longer mention the deprecation.
+1. Remove the corresponding documentation two years after the deprecation date.
+
To see the INFO messages, you must use the `--logLevel` command line flag:
```text
diff --git a/content/en/troubleshooting/faq.md b/content/en/troubleshooting/faq.md
index 4891c566b..2edb309be 100644
--- a/content/en/troubleshooting/faq.md
+++ b/content/en/troubleshooting/faq.md
@@ -51,11 +51,11 @@ If the answer to any of these questions is yes, either change the field values,
###### Why can't I see any of a page's descendants?
-You may have an `index.md` file instead of an `_index.md` file. See [details](/content-management/page-bundles/).
+You may have an `index.md` file instead of an `_index.md` file. See [details](/content-management/page-bundles/).
-###### What is the difference between an index.md file and an _index.md file?
+###### What is the difference between an `index.md` file and an `_index.md` file?
-A directory with an `index.md file` is a [leaf bundle](g). A directory with an `_index.md` file is a [branch bundle](g). See [details](/content-management/page-bundles/).
+A directory with an `index.md file` is a [leaf bundle](g). A directory with an `_index.md` file is a [branch bundle](g). See [details](/content-management/page-bundles/).
###### Why is my partial template not rendered as expected?
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml b/data/sponsors.toml
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/data/sponsors.toml
rename to data/sponsors.toml
diff --git a/go.mod b/go.mod
index 56a48deac..4b9e0a369 100644
--- a/go.mod
+++ b/go.mod
@@ -1,5 +1,3 @@
module github.com/gohugoio/hugoDocs
go 1.22.0
-
-require github.com/gohugoio/gohugoioTheme v0.0.0-20250116152525-2d382cae7743 // indirect
diff --git a/hugo.toml b/hugo.toml
index 2a271b6e3..c0094725f 100644
--- a/hugo.toml
+++ b/hugo.toml
@@ -1,9 +1,7 @@
-# This his the main configuration file. There are also environment specific configuration stored in the /config directory.
-
baseURL = "https://gohugo.io/"
defaultContentLanguage = "en"
enableEmoji = true
-ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"]
+ignoreLogs = ["error-missing-instagram-accesstoken"]
languageCode = "en-us"
pluralizeListTitles = false
timeZone = "Europe/Oslo"
@@ -13,90 +11,164 @@ title = "Hugo"
disableAliases = true
[pagination]
-pagerSize = 100
+ pagerSize = 100
[services.googleAnalytics]
-ID = 'G-MBZGKNMDWC'
-
-[minify]
- [minify.tdewolff]
- [minify.tdewolff.html]
- keepWhitespace = true
-
-[module]
- [module.hugoVersion]
- min = "0.56.0"
- [[module.imports]]
- path = "github.com/gohugoio/gohugoioTheme"
+ ID = 'G-MBZGKNMDWC'
[outputs]
- home = ["HTML", "RSS", "REDIR", "HEADERS"]
- section = ["HTML"]
+ home = ["html", "rss", "redir", "headers"]
+ section = ["html"]
+ page = ["html"]
+ taxonomy = ["html"]
+ term = ["html"]
-[mediaTypes]
- [mediaTypes."text/netlify"]
- delimiter = ""
+[params]
+ description = "The world’s fastest framework for building websites"
+ ghrepo = "https://github.com/gohugoio/hugoDocs/"
+
+ [params.render_hooks.link]
+ errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
+
+[languages]
+ [languages.en]
+ languageName = "English"
+ weight = 1
+
+[security]
+ enableInlineShortcodes = false
+ [security.funcs]
+ getenv = ['^HUGO_', '^REPOSITORY_URL$', '^BRANCH$']
+ [security.http]
+ methods = ['(?i)GET|POST']
+ urls = ['.*']
[outputFormats]
- [outputFormats.REDIR]
- mediatype = "text/netlify"
- baseName = "_redirects"
- isPlainText = true
- notAlternative = true
- [outputFormats.HEADERS]
- mediatype = "text/netlify"
- baseName = "_headers"
- isPlainText = true
- notAlternative = true
+ [outputFormats.redir]
+ mediatype = "text/netlify"
+ baseName = "_redirects"
+ isPlainText = true
+ [outputFormats.headers]
+ mediatype = "text/netlify"
+ baseName = "_headers"
+ isPlainText = true
+ notAlternative = true
-[caches]
- [caches.getjson]
- dir = ":cacheDir/:project"
- maxAge = -1
- [caches.getcsv]
- dir = ":cacheDir/:project"
- maxAge = -1
- [caches.images]
- dir = ":cacheDir/images"
- maxAge = "1440h"
- [caches.assets]
- dir = ":resourceDir/_gen"
- maxAge = -1
- [caches.getresource]
- dir = ":cacheDir/:project"
- maxage = '1h'
+[markup]
+ [markup.highlight]
+ style = 'solarized-dark'
+ lineNumbersInTable = true
+ noClasses = false
+ wrapperClass = 'highlight not-prose'
-[related]
- threshold = 80
- includeNewer = true
- toLower = false
- [[related.indices]]
- name = "keywords"
- weight = 60
- [[related.indices]]
- # Can be used as a front matter slice to link to other page fragments (headings) using their ID.
- # This isn't particular useful in the current docs, but we're planning on getting a auto generated
- # reference section with a better ID setup.
- # For now, we just use it to give pages with same headings some similarity score.
- name = "fragmentrefs"
- type = "fragments"
- applyFilter = false
- weight = 60
- cardinalityThreshold = 50
+ [markup.goldmark.renderer]
+ hardWraps = false
+ unsafe = false
+ xhtml = false
-[imaging]
- # See https://github.com/disintegration/imaging
- # CatmullRom is a sharp bicubic filter which should fit the docs site well with its many screenshots.
- # Note that you can also set this per image processing.
- resampleFilter = "CatmullRom"
- # Default JPEG quality setting. Default is 75.
- quality = 75
- anchor = "smart"
+ [markup.goldmark.extensions]
+ definitionList = true
+ footnote = true
+ linkify = true
+ strikethrough = true
+ table = true
+ taskList = true
+ typographer = true
-[taxonomies]
- category = "categories"
+ [markup.goldmark.extensions.passthrough]
+ enable = true
-[[cascade]]
-categories = ['commands']
-[cascade._target]
-path = '/commands/**'
+ [markup.goldmark.extensions.passthrough.delimiters]
+ block = [['\[', '\]'], ['$$', '$$']]
+ inline = [['\(', '\)']]
+
+ [markup.goldmark.parser]
+ autoHeadingID = true
+ autoHeadingIDType = "github"
+
+ [markup.goldmark.parser.attribute]
+ block = true
+ title = true
+
+[mediaTypes]
+ [mediaTypes."text/netlify"]
+ delimiter = ""
+
+[module]
+ [module.hugoVersion]
+ min = "0.141.0"
+ [[module.mounts]]
+ source = "assets"
+ target = "assets"
+ [[module.mounts]]
+ lang = 'en'
+ source = 'content/en'
+ target = 'content'
+ [[module.mounts]]
+ source = "hugo_stats.json"
+ target = "assets/notwatching/hugo_stats.json"
+ disableWatch = true
+
+[build]
+ [build.buildStats]
+ disableIDs = true
+ enable = true
+ [[build.cachebusters]]
+ source = "assets/notwatching/hugo_stats\\.json"
+ target = "css"
+ [[build.cachebusters]]
+ source = "(postcss|tailwind)\\.config\\.js"
+ target = "css"
+
+[server]
+ [[server.headers]]
+ for = "/*"
+
+ [server.headers.values]
+ X-Frame-Options = "DENY"
+ X-XSS-Protection = "1; mode=block"
+ X-Content-Type-Options = "nosniff"
+ Referrer-Policy = "no-referrer"
+
+ [[server.headers]]
+ for = "/**.{css,js}"
+
+[minify]
+ [minify.tdewolff]
+ [minify.tdewolff.html]
+ keepSpecialComments = true
+ keepWhitespace = false
+
+######## GLOBAL ITEMS TO BE SHARED WITH THE HUGO SITES ########
+[menus]
+ [[menus.global]]
+ name = 'News'
+ weight = 1
+ identifier = 'news'
+ pageRef = '/news/'
+
+ [[menus.global]]
+ name = 'Docs'
+ weight = 5
+ identifier = 'docs'
+ url = '/documentation/'
+
+ [[menus.global]]
+ name = 'Themes'
+ weight = 10
+ identifier = 'themes'
+ url = 'https://themes.gohugo.io/'
+
+ [[menus.global]]
+ name = 'Community'
+ weight = 150
+ identifier = 'community'
+ post = 'external'
+ url = 'https://discourse.gohugo.io/'
+
+ [[menus.global]]
+ name = 'GitHub'
+ weight = 200
+ identifier = 'github'
+ post = 'external'
+ url = 'https://github.com/gohugoio/hugo'
diff --git a/hugo.work b/hugo.work
index b2ae38c07..02c0ba91f 100644
--- a/hugo.work
+++ b/hugo.work
@@ -1,4 +1,4 @@
go 1.22.0
use .
-use ../gohugoioTheme
+
diff --git a/layouts/404.html b/layouts/404.html
new file mode 100644
index 000000000..bb92ea160
--- /dev/null
+++ b/layouts/404.html
@@ -0,0 +1,22 @@
+{{ define "main" }}
+
+
+ The world’s fastest framework for building websites
+
+
+ Hugo is one of the most popular open-source static site generators.
+ With its amazing speed and flexibility, Hugo makes building websites
+ fun again.
+
+
+ {{ with site.GetPage "/getting-started" }}
+ {{ .LinkTitle }}
+ {{ end }}
+
+ {{ end }}
+ {{ end }}
+{{ end }}
diff --git a/layouts/partials/news/get-news-items.html b/layouts/partials/news/get-news-items.html
new file mode 100644
index 000000000..cb1a930d3
--- /dev/null
+++ b/layouts/partials/news/get-news-items.html
@@ -0,0 +1,45 @@
+{{ $news_items := slice }}
+
+{{/* Get releases from GitHub. */}}
+{{ $u := "https://api.github.com/repos/gohugoio/hugo/releases" }}
+{{ $releases := partial "helpers/funcs/get-remote-data.html" $u }}
+{{ $releases = where $releases "draft" false }}
+{{ $releases = where $releases "prerelease" false }}
+{{ range $releases | first 20 }}
+ {{ $publishDate := .published_at | time.AsTime }}
+
+ {{/* Correct the v0.138.0 release date. See https://github.com/gohugoio/hugo/issues/13066. */}}
+ {{ if eq .name "v0.138.0" }}
+ {{ $publishDate = "2024-11-06T11:22:34Z" | time.AsTime }}
+ {{ end }}
+
+ {{ $ctx := dict
+ "Date" $publishDate
+ "Title" (printf "Release %s" .name)
+ "LinkTitle" (printf "Release %s" .name)
+ "Permalink" .html_url
+ "RelPermalink" .html_url
+ "Section" "news"
+ "Summary" ""
+ }}
+ {{ $news_items = $news_items | append $ctx }}
+{{ end }}
+
+{{/* Get content pages from news section. */}}
+{{ range .Pages }}
+ {{ $ctx := dict
+ "Date" .Date
+ "Title" .Title
+ "LinkTitle" .Title
+ "RelPermalink" .RelPermalink
+ "Section" "news"
+ "Summary" .Summary
+ "Params" (dict "description" .Description)
+ }}
+ {{ $news_items = $news_items | append $ctx }}
+{{ end }}
+
+{{/* Sort by date (descending) and render. */}}
+{{ $news_items = sort $news_items "Date" "desc" }}
+
+{{ return $news_items }}
diff --git a/layouts/partials/opengraph/get-featured-image.html b/layouts/partials/opengraph/get-featured-image.html
new file mode 100644
index 000000000..50ee2a44d
--- /dev/null
+++ b/layouts/partials/opengraph/get-featured-image.html
@@ -0,0 +1,26 @@
+{{ $images := $.Resources.ByType "image" }}
+{{ $featured := $images.GetMatch "*feature*" }}
+{{ if not $featured }}
+ {{ $featured = $images.GetMatch "{*cover*,*thumbnail*}" }}
+{{ end }}
+{{ if not $featured }}
+ {{ $featured = resources.Get "/opengraph/gohugoio-card-base-1.png" }}
+ {{ $size := 80 }}
+ {{ $title := $.LinkTitle }}
+ {{ if gt (len $title) 20 }}
+ {{ $size = 70 }}
+ {{ end }}
+
+ {{ $text := $title }}
+ {{ $textOptions := dict
+ "color" "#FFF"
+ "size" $size
+ "lineSpacing" 10
+ "x" 65 "y" 80
+ "font" (resources.Get "/opengraph/mulish-black.ttf")
+ }}
+
+ {{ $featured = $featured | images.Filter (images.Text $text $textOptions) }}
+{{ end }}
+
+{{ return $featured }}
diff --git a/layouts/partials/opengraph/opengraph.html b/layouts/partials/opengraph/opengraph.html
new file mode 100644
index 000000000..1c89b0814
--- /dev/null
+++ b/layouts/partials/opengraph/opengraph.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+{{- with $.Params.images -}}
+ {{- range first 6 . }}
+
+ {{ end -}}
+{{- else -}}
+ {{- $featured := partial "opengraph/get-featured-image.html" . }}
+ {{- with $featured -}}
+
+ {{- else -}}
+ {{- with $.Site.Params.images }}
+
+ {{ end -}}
+ {{- end -}}
+{{- end -}}
+
+{{- if .IsPage }}
+ {{- $iso8601 := "2006-01-02T15:04:05-07:00" -}}
+
+ {{ with .PublishDate }}
+
+ {{ end }}
+ {{ with .Lastmod }}
+
+ {{ end }}
+{{- end -}}
+
+{{- with .Params.audio }}{{ end }}
+{{- with .Params.locale }}
+
+{{ end }}
+{{- with .Site.Params.title }}
+
+{{ end }}
+{{- with .Params.videos }}
+ {{- range . }}
+
+ {{ end }}
+
+{{ end }}
+
+{{- /* If it is part of a series, link to related articles */}}
+{{- $permalink := .Permalink }}
+{{- $siteSeries := .Site.Taxonomies.series }}
+{{ with .Params.series }}
+ {{- range $name := . }}
+ {{- $series := index $siteSeries ($name | urlize) }}
+ {{- range $page := first 6 $series.Pages }}
+ {{- if ne $page.Permalink $permalink }}
+
+ {{ end }}
+ {{- end }}
+ {{ end }}
+
+{{ end }}
+
+{{- /* Facebook Page Admin ID for Domain Insights */}}
+{{- with site.Params.social.facebook_admin }}
+
+{{ end }}
diff --git a/layouts/shortcodes/chroma-lexers.html b/layouts/shortcodes/chroma-lexers.html
new file mode 100644
index 000000000..38241be33
--- /dev/null
+++ b/layouts/shortcodes/chroma-lexers.html
@@ -0,0 +1,7 @@
+
+ {{ range .Site.Data.docs.chroma.lexers }}
+
{{ .Name }}
+
{{ with .Aliases }}{{ delimit . ", " }}{{ end }}
+ {{ end }}
+
+
\ No newline at end of file
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/code-toggle.html b/layouts/shortcodes/code-toggle.html
similarity index 59%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/code-toggle.html
rename to layouts/shortcodes/code-toggle.html
index d1131132d..4e64fded0 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/code-toggle.html
+++ b/layouts/shortcodes/code-toggle.html
@@ -60,27 +60,43 @@
{{- else }}
{{- $code = $.Inner }}
{{- end }}
-
-
- {{- with $file }}
-
+
+
+
-
- {{- range $langs }}
+ {{ end }}
+
+ {{ if $code }}
+ {{ range $i, $lang := $langs }}
- {{- if $copy }}
-
- {{- /* Functionality located within filesaver.js The copy here is located in the css with .copy class so it can be replaced with JS on success */}}
- {{- end }}
- {{- end }}
-
+ {{ end }}
+ {{ end }}
diff --git a/layouts/shortcodes/code.html b/layouts/shortcodes/code.html
new file mode 100644
index 000000000..1ccb44b7d
--- /dev/null
+++ b/layouts/shortcodes/code.html
@@ -0,0 +1,38 @@
+{{- $codeLang := or (.Get "lang") "" }}
+
+ {{ if (.Get "copy") }}
+
+ {{ end }}
+ {{- with .Get "file" -}}
+ {{- if not $codeLang }}
+ {{- $ext := strings.TrimPrefix "." (path.Ext .) }}
+ {{- $codeLang = cond (eq $ext "html") "go-html-template" $ext }}
+ {{- end }}
+
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/datatable-filtered.html b/layouts/shortcodes/datatable-filtered.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/datatable-filtered.html
rename to layouts/shortcodes/datatable-filtered.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/datatable.html b/layouts/shortcodes/datatable.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/datatable.html
rename to layouts/shortcodes/datatable.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/deprecated-in.html b/layouts/shortcodes/deprecated-in.html
similarity index 61%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/deprecated-in.html
rename to layouts/shortcodes/deprecated-in.html
index 7219d7f54..0272ea4a6 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/deprecated-in.html
+++ b/layouts/shortcodes/deprecated-in.html
@@ -3,12 +3,15 @@
{{ with .Get 0 }}
{{ $version := printf "v%v" (strings.TrimLeft "vV" .) }}
{{ $href := printf "https://github.com/gohugoio/hugo/releases/tag/%s" $version }}
-
+ {{ $text := (printf `Deprecated in %s.
+%s` $href $version $.Inner) | safeHTML }}
+
+ {{ partial "layouts/blocks/alert.html" (dict
+ "text" $text
+ "color" "orange"
+ "icon" "exclamation"
+ )
+}}
{{ else }}
{{ errorf "The %q shortcode requires a single positional parameter indicating version. See %s" .Name .Position }}
{{ end }}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/eturl.html b/layouts/shortcodes/eturl.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/eturl.html
rename to layouts/shortcodes/eturl.html
diff --git a/layouts/shortcodes/glossary-term.html b/layouts/shortcodes/glossary-term.html
index 92ad93340..7aace730e 100644
--- a/layouts/shortcodes/glossary-term.html
+++ b/layouts/shortcodes/glossary-term.html
@@ -9,12 +9,12 @@ Renders the definition of the given glossary term.
*/}}
{{- with .Get 0 }}
- {{- $path := printf "/getting-started/glossary/%s" (urlize .) }}
+ {{- $path := printf "/quick-reference/glossary/%s" (urlize .) }}
{{- with site.GetPage $path }}
-{{ .RenderShortcodes }}{{/* Do not indent. */}}
+{{ .RenderShortcodes }} {{/* Do not indent. Do not remove non-breaking space. */}}
{{- else }}
{{- errorf "The glossary term (%s) shortcode was unable to find %s: see %s" $.Name $path $.Position }}
{{- end }}
{{- else }}
{{- errorf "The glossary term (%s) shortcode requires one positional parameter: see %s" $.Name $.Position }}
-{{- end }}
+{{- end -}}
diff --git a/layouts/shortcodes/glossary.html b/layouts/shortcodes/glossary.html
index 3273efd8c..e91be32ce 100644
--- a/layouts/shortcodes/glossary.html
+++ b/layouts/shortcodes/glossary.html
@@ -13,13 +13,12 @@ shortcode.
@example {{% glossary %}}
*/}}
-{{- $path := "/getting-started/glossary" }}
+{{- $path := "/quick-reference/glossary" }}
{{- with site.GetPage $path }}
- {{- with $p := .Pages.ByTitle }}
{{- /* Build and render alphabetical index. */}}
{{- $m := dict }}
- {{- range $p }}
+ {{- range $p := .Pages.ByTitle }}
{{- $k := substr .Title 0 1 | strings.ToUpper }}
{{- if index $m $k }}
{{- continue }}
@@ -32,12 +31,26 @@ shortcode.
{{- end }}
{{- /* Render glossary terms. */}}
- {{- range $p }}
+ {{- range $p := .Pages.ByTitle }}
###### {{ .Title }}{{/* Do not indent. */}}
{{ .RenderShortcodes }}{{/* Do not indent. */}}
+ {{- with .Params.reference }}
+ {{- $destination := "" }}
+ {{- with $u := urls.Parse . }}
+ {{- if $u.IsAbs }}
+ {{- $destination = $u.String }}
+ {{- else }}
+ {{- with site.GetPage $u.Path -}}
+ {{- $destination = .RelPermalink }}
+ {{- else }}
+ {{- errorf "The %q shortcode was unable to find the reference link %s: see %s" $.Name . $p.String }}
+ {{- end }}
+ {{- end }}
+ {{- end -}}
+ See [details]({{ $destination }}).{{/* Do not indent. */}}
+ {{- end }}
{{- end }}
- {{- end }}
{{- else }}
{{- errorf "The %q shortcode was unable to get %s: see %s" .Name $path .Position}}
{{- end }}
diff --git a/layouts/shortcodes/gomodules-info.html b/layouts/shortcodes/gomodules-info.html
new file mode 100644
index 000000000..126d846c0
--- /dev/null
+++ b/layouts/shortcodes/gomodules-info.html
@@ -0,0 +1,12 @@
+{{ $text := `
+ Most of the commands for **Hugo Modules** require a newer version (>= 1.18) of Go installed (see https://golang.org/dl/) and the relevant VCS client (e.g. Git, see https://git-scm.com/downloads/ ).
+ If you have an "older" site running on Netlify, you may have to set GO_VERSION to 1.19 or newer in your Environment settings.
+
+ For more information about Go Modules, see:
+
+ * https://go.dev/wiki/Modules
+ * https://blog.golang.org/using-go-modules
+ `
+}}
+
+{{ partial "layouts/blocks/alert.html" (dict "title" "Go Modules" "text" ($text | markdownify) "color" "orange" "icon" "exclamation") }}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/hl.html b/layouts/shortcodes/hl.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/hl.html
rename to layouts/shortcodes/hl.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/img.html b/layouts/shortcodes/img.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/img.html
rename to layouts/shortcodes/img.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/imgproc.html b/layouts/shortcodes/imgproc.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/imgproc.html
rename to layouts/shortcodes/imgproc.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html b/layouts/shortcodes/include.html
similarity index 76%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html
rename to layouts/shortcodes/include.html
index 9456e197e..b4a20cd72 100644
--- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/include.html
+++ b/layouts/shortcodes/include.html
@@ -10,10 +10,11 @@ You must call this shortcode using the {{% %}} notation.
*/}}
{{- with .Get 0 }}
- {{- with $.Page.GetPage . }}
+ {{- with or ($.Page.GetPage .) (site.GetPage .) }}
{{- .RenderShortcodes }}
{{- else }}
- {{- errorf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
+ {{/* TODO1 make error */}}
+ {{- warnf "The %q shortcode was unable to find %q. See %s" $.Name . $.Position }}
{{- end }}
{{- else }}
{{- errorf "The %q shortcode requires a positional parameter indicating the path of the file to include. See %s" .Name .Position }}
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/list-pages-in-section.html b/layouts/shortcodes/list-pages-in-section.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/list-pages-in-section.html
rename to layouts/shortcodes/list-pages-in-section.html
diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/module-mounts-note.html b/layouts/shortcodes/module-mounts-note.html
similarity index 100%
rename from _vendor/github.com/gohugoio/gohugoioTheme/layouts/shortcodes/module-mounts-note.html
rename to layouts/shortcodes/module-mounts-note.html
diff --git a/layouts/shortcodes/new-in.html b/layouts/shortcodes/new-in.html
new file mode 100644
index 000000000..e99cc7bcf
--- /dev/null
+++ b/layouts/shortcodes/new-in.html
@@ -0,0 +1,66 @@
+{{- /*
+ Renders a "new in" button indicating the version in which a feature was added.
+
+ When comparing the current version to the specified version, the "new in"
+ button will be hidden if any of the following conditions is true:
+
+ - The major version difference exceeds the majorVersionDiffThreshold
+ - The minor version difference exceeds the minorVersionDiffThreshold
+
+ @param {string} version The semantic version string, with or without a leading v.
+ @returns {template.HTML}
+
+ @examples {{< new-in 0.100.0 /
+>}}
+
+{{< new-in 0.100.0 >}}
+Some descriptive text here.
+{{< /new-in >}}
+*/}}
+{{ $_hugo_config := `{ "version": 1 }` }}
+
+{{- /* Set defaults. */}}
+{{- $majorVersionDiffThreshold := 0 }}
+{{- $minorVersionDiffThreshold := 30 }}
+{{- $displayExpirationWarning := true }}
+
+{{- /* Render. */}}
+{{- with $version := .Get 0 | strings.TrimPrefix "v" }}
+ {{- $majorVersionDiff := sub (index (split hugo.Version ".") 0 | int) (index (split $version ".") 0 | int) }}
+ {{- $minorVersionDiff := sub (index (split hugo.Version ".") 1 | int) (index (split $version ".") 1 | int) }}
+ {{- if or (gt $majorVersionDiff $majorVersionDiffThreshold) (gt $minorVersionDiff $minorVersionDiffThreshold) }}
+ {{- if $displayExpirationWarning }}
+ {{- warnf "This call to the %q shortcode should be removed: %s. The button is now hidden because the specified version (%s) is older than the display threshold." $.Name $.Position $version }}
+ {{- end }}
+ {{- else }}
+ {{- $href := printf "https://github.com/gohugoio/hugo/releases/tag/v%s" $version }}
+ {{- with $.Inner }}
+ {{ $text := printf `
- {{end}}
- 
- 
```
-## Error handling in shortcodes
+### Other examples
-Use the [`errorf`] template function with the [`Name`] and [`Position`] shortcode methods to generate useful error messages:
+For guidance, consider examining Hugo's embedded shortcodes. The source code, available on [GitHub], can provide a useful model.
-{{< code file=layouts/shortcodes/greeting.html >}}
-{{ with .Get "name" }}
- 
+ 
+