diff --git a/docs/config/_default/security.toml b/docs/config/_default/security.toml index 2be3f1ba847..8bd91945fef 100644 --- a/docs/config/_default/security.toml +++ b/docs/config/_default/security.toml @@ -1,10 +1,6 @@ enableInlineShortcodes = false - [exec] - allow = ['^go$'] - osEnv = ['^PATH$'] - [funcs] getenv = ['^HUGO_', '^REPOSITORY_URL$', '^BRANCH$'] diff --git a/docs/content/en/content-management/multilingual.md b/docs/content/en/content-management/multilingual.md index 4c1f6446e02..849df681f0f 100644 --- a/docs/content/en/content-management/multilingual.md +++ b/docs/content/en/content-management/multilingual.md @@ -506,7 +506,7 @@ See [lang.FormatNumber] and [lang.FormatNumberCustom] for details. With this template code: ```go-html-template -{{ 512.5032 | lang.FormatPercent 2 }} ---> 512.50% +{{ 512.5032 | lang.FormatPercent 2 }} → 512.50% ``` The rendered page displays: diff --git a/docs/content/en/content-management/summaries.md b/docs/content/en/content-management/summaries.md index 4f94f95f25c..74c5623cbf2 100644 --- a/docs/content/en/content-management/summaries.md +++ b/docs/content/en/content-management/summaries.md @@ -85,19 +85,19 @@ You can show content summaries with the following code. You could use the follow {{< code file="page-list-with-summaries.html" >}} {{ range first 10 .Pages }} -
- -
-

{{ .Title }}

- {{ .Summary }} -
- {{ if .Truncated }} +
+ +
+

{{ .Title }}

+ {{ .Summary }} +
+ {{ if .Truncated }}
Read More…
- {{ end }} -
+ {{ end }} +
{{ end }} {{< /code >}} diff --git a/docs/content/en/content-management/toc.md b/docs/content/en/content-management/toc.md index e1f24378eb4..ca179c77dc1 100644 --- a/docs/content/en/content-management/toc.md +++ b/docs/content/en/content-management/toc.md @@ -50,17 +50,17 @@ The following is an example of a very basic [single page template]: {{< code file="layout/_default/single.html" >}} {{ define "main" }} -
+
-
+

{{ .Title }}

-
- {{ .Content }} +
+ {{ .Content }}
-
+
{{ end }} {{< /code >}} diff --git a/docs/content/en/functions/adddate.md b/docs/content/en/functions/adddate.md index 96a9df83395..cae270fb88e 100644 --- a/docs/content/en/functions/adddate.md +++ b/docs/content/en/functions/adddate.md @@ -13,11 +13,11 @@ relatedfuncs: [now] ```go-html-template {{ $d := "2022-01-01" | time.AsTime }} -{{ $d.AddDate 0 0 1 | time.Format "2006-01-02" }} --> 2022-01-02 -{{ $d.AddDate 0 1 1 | time.Format "2006-01-02" }} --> 2022-02-02 -{{ $d.AddDate 1 1 1 | time.Format "2006-01-02" }} --> 2023-02-02 +{{ $d.AddDate 0 0 1 | time.Format "2006-01-02" }} → 2022-01-02 +{{ $d.AddDate 0 1 1 | time.Format "2006-01-02" }} → 2022-02-02 +{{ $d.AddDate 1 1 1 | time.Format "2006-01-02" }} → 2023-02-02 -{{ $d.AddDate -1 -1 -1 | time.Format "2006-01-02" }} --> 2020-11-30 +{{ $d.AddDate -1 -1 -1 | time.Format "2006-01-02" }} → 2020-11-30 ``` {{% note %}} @@ -28,11 +28,11 @@ See [this explanation](https://github.com/golang/go/issues/31145#issuecomment-47 ```go-html-template {{ $d := "2023-01-31" | time.AsTime }} -{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} --> 2023-03-03 +{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2023-03-03 {{ $d := "2024-01-31" | time.AsTime }} -{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} --> 2024-03-02 +{{ $d.AddDate 0 1 0 | time.Format "2006-01-02" }} → 2024-03-02 {{ $d := "2024-02-29" | time.AsTime }} -{{ $d.AddDate 1 0 0 | time.Format "2006-01-02" }} --> 2025-03-01 +{{ $d.AddDate 1 0 0 | time.Format "2006-01-02" }} → 2025-03-01 ``` diff --git a/docs/content/en/functions/after.md b/docs/content/en/functions/after.md index 5318d3b0c63..85aa6104dd7 100644 --- a/docs/content/en/functions/after.md +++ b/docs/content/en/functions/after.md @@ -33,7 +33,7 @@ You can use `after` in combination with the [`first` function] and Hugo's [power

Featured Article

{{ range first 1 .Pages.ByPublishDate.Reverse }}
-

{{ .Title }}

+

{{ .Title }}

{{ .Description }}

{{ end }} diff --git a/docs/content/en/functions/anchorize.md b/docs/content/en/functions/anchorize.md index bdf322a6e47..51ef67bb251 100644 --- a/docs/content/en/functions/anchorize.md +++ b/docs/content/en/functions/anchorize.md @@ -15,10 +15,10 @@ If [Goldmark](/getting-started/configuration-markup#goldmark) is set as `default Since the `defaultMarkdownHandler` and this template function use the same sanitizing logic, you can use the latter to determine the ID of a header for linking with anchor tags. ```go-html-template -{{ anchorize "This is a header" }} --> "this-is-a-header" -{{ anchorize "This is also a header" }} --> "this-is-also----a-header" -{{ anchorize "main.go" }} --> "maingo" -{{ anchorize "Article 123" }} --> "article-123" -{{ anchorize "<- Let's try this, shall we?" }} --> "--lets-try-this-shall-we" -{{ anchorize "Hello, 世界" }} --> "hello-世界" +{{ anchorize "This is a header" }} → "this-is-a-header" +{{ anchorize "This is also a header" }} → "this-is-also----a-header" +{{ anchorize "main.go" }} → "maingo" +{{ anchorize "Article 123" }} → "article-123" +{{ anchorize "<- Let's try this, shall we?" }} → "--lets-try-this-shall-we" +{{ anchorize "Hello, 世界" }} → "hello-世界" ``` diff --git a/docs/content/en/functions/append.md b/docs/content/en/functions/append.md index 626bc124251..6d7ffa24568 100644 --- a/docs/content/en/functions/append.md +++ b/docs/content/en/functions/append.md @@ -26,4 +26,12 @@ The same example appending a slice to a slice: {{ $s = $s | append (slice "d" "e") }} ``` +If a slice contains other slices, further slices will be appended as values: + +```go-html-template +{{ $s := slice (slice "a" "b") (slice "c" "d") }} +{{ $s = $s | append (slice "e" "f") (slice "g" "h") }} +{{/* $s now contains a [][]string containing four slices: ["a" "b"], ["c" "d"], ["e" "f"], and ["g" "h"] */}} +``` + The `append` function works for all types, including `Pages`. diff --git a/docs/content/en/functions/common/index.md b/docs/content/en/functions/common/index.md new file mode 100644 index 00000000000..cbb7365a66e --- /dev/null +++ b/docs/content/en/functions/common/index.md @@ -0,0 +1,3 @@ ++++ +headless = true ++++ diff --git a/docs/content/en/functions/common/regular-expressions.md b/docs/content/en/functions/common/regular-expressions.md new file mode 100644 index 00000000000..9da340849f6 --- /dev/null +++ b/docs/content/en/functions/common/regular-expressions.md @@ -0,0 +1,8 @@ +When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. + +Go's regular expression package implements the [RE2 syntax]. The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. Note that the RE2 `\C` escape sequence is not supported. + +[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats +[PCRE]: https://www.pcre.org/ +[RE2 syntax]: https://github.com/google/re2/wiki/Syntax/ +[string literal]: https://go.dev/ref/spec#String_literals diff --git a/docs/content/en/functions/fileExists.md b/docs/content/en/functions/fileExists.md index 5a365b7c14b..f7b5c37e0d7 100644 --- a/docs/content/en/functions/fileExists.md +++ b/docs/content/en/functions/fileExists.md @@ -24,11 +24,11 @@ content/ The function returns these values: ```go-html-template -{{ os.FileExists "content" }} --> true -{{ os.FileExists "content/news" }} --> true -{{ os.FileExists "content/news/article-1" }} --> false -{{ os.FileExists "content/news/article-1.md" }} --> true -{{ os.FileExists "news" }} --> true -{{ os.FileExists "news/article-1" }} --> false -{{ os.FileExists "news/article-1.md" }} --> true +{{ os.FileExists "content" }} → true +{{ os.FileExists "content/news" }} → true +{{ os.FileExists "content/news/article-1" }} → false +{{ os.FileExists "content/news/article-1.md" }} → true +{{ os.FileExists "news" }} → true +{{ os.FileExists "news/article-1" }} → false +{{ os.FileExists "news/article-1.md" }} → true ``` diff --git a/docs/content/en/functions/findRe.md b/docs/content/en/functions/findRe.md index 0b8978ec6af..3c977118c85 100644 --- a/docs/content/en/functions/findRe.md +++ b/docs/content/en/functions/findRe.md @@ -13,21 +13,7 @@ relatedfuncs: [findRESubmatch, replaceRE] --- By default, `findRE` finds all matches. You can limit the number of matches with an optional LIMIT parameter. -When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. - -[string literal]: https://go.dev/ref/spec#String_literals - -This function uses the [RE2] regular expression library. See the [RE2 syntax documentation] for details. Note that the RE2 `\C` escape sequence is not supported. - -[RE2]: https://github.com/google/re2/ -[RE2 syntax documentation]: https://github.com/google/re2/wiki/Syntax/ - -{{% note %}} -The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. - -[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats -[PCRE]: https://www.pcre.org/ -{{% /note %}} +{{% readfile file="/functions/common/regular-expressions.md" %}} This example returns a slice of all second level headings (`h2` elements) within the rendered `.Content`: diff --git a/docs/content/en/functions/findresubmatch.md b/docs/content/en/functions/findresubmatch.md index e1085a9c9cc..1f0f26b4938 100644 --- a/docs/content/en/functions/findresubmatch.md +++ b/docs/content/en/functions/findresubmatch.md @@ -14,21 +14,7 @@ relatedfuncs: [findRE, replaceRE] By default, `findRESubmatch` finds all matches. You can limit the number of matches with an optional LIMIT parameter. A return value of nil indicates no match. -When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. - -[string literal]: https://go.dev/ref/spec#String_literals - -This function uses the [RE2] regular expression library. See the [RE2 syntax documentation] for details. Note that the RE2 `\C` escape sequence is not supported. - -[RE2]: https://github.com/google/re2/ -[RE2 syntax documentation]: https://github.com/google/re2/wiki/Syntax/ - -{{% note %}} -The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. - -[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats -[PCRE]: https://www.pcre.org/ -{{% /note %}} +{{% readfile file="/functions/common/regular-expressions.md" %}} ## Demonstrative examples diff --git a/docs/content/en/functions/getenv.md b/docs/content/en/functions/getenv.md index e014b7ad5c1..daeeb653236 100644 --- a/docs/content/en/functions/getenv.md +++ b/docs/content/en/functions/getenv.md @@ -12,8 +12,8 @@ relatedfuncs: [] Examples: ```go-html-template -{{ os.Getenv "HOME" }} --> /home/victor -{{ os.Getenv "USER" }} --> victor +{{ os.Getenv "HOME" }} → /home/victor +{{ os.Getenv "USER" }} → victor ``` You can pass values when building your site: @@ -31,8 +31,8 @@ hugo And then retrieve the values within a template: ```go-html-template -{{ os.Getenv "MY_VAR1" }} --> foo -{{ os.Getenv "MY_VAR2" }} --> bar +{{ os.Getenv "MY_VAR1" }} → foo +{{ os.Getenv "MY_VAR2" }} → bar ``` With Hugo v0.91.0 and later, you must explicitly allow access to environment variables. For details, review [Hugo's Security Policy](/about/security-model/#security-policy). By default, environment variables beginning with `HUGO_` are allowed when using the `os.Getenv` function. diff --git a/docs/content/en/functions/hasPrefix.md b/docs/content/en/functions/hasPrefix.md deleted file mode 100644 index 2640445774d..00000000000 --- a/docs/content/en/functions/hasPrefix.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: hasprefix -description: Tests whether a string begins with prefix. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -categories: [functions] -menu: - docs: - parent: "functions" -keywords: [strings] -signature: ["hasPrefix STRING PREFIX"] -workson: [] -hugoversion: -relatedfuncs: [hasSuffix] -deprecated: false -aliases: [] ---- - -* `{{ hasPrefix "Hugo" "Hu" }}` → true diff --git a/docs/content/en/functions/hasSuffix.md b/docs/content/en/functions/hasSuffix.md deleted file mode 100644 index 5ab38866d59..00000000000 --- a/docs/content/en/functions/hasSuffix.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: hassuffix -linkTitle: hasSuffix -description: Tests whether a string ends with suffix. -date: 2023-03-01 -publishdate: 2023-03-01 -lastmod: 2023-03-01 -categories: [functions] -menu: -docs: -parent: "functions" -keywords: [strings] -signature: ["hasSuffix STRING SUFFIX"] -workson: [] -hugoversion: -relatedfuncs: [hasPrefix] -deprecated: false -aliases: [] ---- - -* `{{ hasSuffix "Hugo" "go" }}` → true diff --git a/docs/content/en/functions/merge.md b/docs/content/en/functions/merge.md index 68e56145030..ed370549e16 100644 --- a/docs/content/en/functions/merge.md +++ b/docs/content/en/functions/merge.md @@ -27,9 +27,9 @@ Example 1 ```go-html-template {{ $merged := merge $m1 $m2 $m3 }} -{{ $merged.x }} --> baz -{{ $merged.y }} --> wobble -{{ $merged.z.a }} --> huey +{{ $merged.x }} → baz +{{ $merged.y }} → wobble +{{ $merged.z.a }} → huey ``` Example 2 @@ -37,9 +37,9 @@ Example 2 ```go-html-template {{ $merged := merge $m3 $m2 $m1 }} -{{ $merged.x }} --> foo -{{ $merged.y }} --> wibble -{{ $merged.z.a }} --> huey +{{ $merged.x }} → foo +{{ $merged.y }} → wibble +{{ $merged.z.a }} → huey ``` Example 3 @@ -47,9 +47,9 @@ Example 3 ```go-html-template {{ $merged := merge $m2 $m3 $m1 }} -{{ $merged.x }} --> foo -{{ $merged.y }} --> wobble -{{ $merged.z.a }} --> huey +{{ $merged.x }} → foo +{{ $merged.y }} → wobble +{{ $merged.z.a }} → huey ``` Example 4 @@ -57,9 +57,9 @@ Example 4 ```go-html-template {{ $merged := merge $m1 $m3 $m2 }} -{{ $merged.x }} --> bar -{{ $merged.y }} --> wibble -{{ $merged.z.a }} --> huey +{{ $merged.x }} → bar +{{ $merged.y }} → wibble +{{ $merged.z.a }} → huey ``` {{% note %}} diff --git a/docs/content/en/functions/os.Stat.md b/docs/content/en/functions/os.Stat.md index 9ace3b8bfbf..51d35ae2f50 100644 --- a/docs/content/en/functions/os.Stat.md +++ b/docs/content/en/functions/os.Stat.md @@ -13,13 +13,13 @@ The `os.Stat` function attempts to resolve the path relative to the root of your ```go-html-template {{ $f := os.Stat "README.md" }} -{{ $f.IsDir }} --> false (bool) -{{ $f.ModTime }} --> 2021-11-25 10:06:49.315429236 -0800 PST (time.Time) -{{ $f.Name }} --> README.md (string) -{{ $f.Size }} --> 241 (int64) +{{ $f.IsDir }} → false (bool) +{{ $f.ModTime }} → 2021-11-25 10:06:49.315429236 -0800 PST (time.Time) +{{ $f.Name }} → README.md (string) +{{ $f.Size }} → 241 (int64) {{ $d := os.Stat "content" }} -{{ $d.IsDir }} --> true (bool) +{{ $d.IsDir }} → true (bool) ``` Details of the `FileInfo` structure are available in the [Go documentation](https://pkg.go.dev/io/fs#FileInfo). diff --git a/docs/content/en/functions/readdir.md b/docs/content/en/functions/readdir.md index 9fc4d301354..a76e3c5f66a 100644 --- a/docs/content/en/functions/readdir.md +++ b/docs/content/en/functions/readdir.md @@ -26,7 +26,7 @@ This template code: ```go-html-template {{ range os.ReadDir "content" }} - {{ .Name }} --> {{ .IsDir }} + {{ .Name }} → {{ .IsDir }} {{ end }} ``` diff --git a/docs/content/en/functions/replacere.md b/docs/content/en/functions/replacere.md index 22f81a2f58a..8c3cc13c215 100644 --- a/docs/content/en/functions/replacere.md +++ b/docs/content/en/functions/replacere.md @@ -13,21 +13,7 @@ relatedfuncs: [findRE, FindRESubmatch, replace] --- By default, `replaceRE` replaces all matches. You can limit the number of matches with an optional LIMIT parameter. -When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. - -[string literal]: https://go.dev/ref/spec#String_literals - -This function uses the [RE2] regular expression library. See the [RE2 syntax documentation] for details. Note that the RE2 `\C` escape sequence is not supported. - -[RE2]: https://github.com/google/re2/ -[RE2 syntax documentation]: https://github.com/google/re2/wiki/Syntax/ - -{{% note %}} -The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. - -[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats -[PCRE]: https://www.pcre.org/ -{{% /note %}} +{{% readfile file="/functions/common/regular-expressions.md" %}} This example replaces two or more consecutive hyphens with a single hyphen: diff --git a/docs/content/en/functions/scratch.md b/docs/content/en/functions/scratch.md index 2e00f41bde8..16e502b84d7 100644 --- a/docs/content/en/functions/scratch.md +++ b/docs/content/en/functions/scratch.md @@ -72,7 +72,7 @@ Get the value of a given key. Add a given value to existing value(s) of the given key. -For single values, `Add` accepts values that support Go's `+` operator. If the first `Add` for a key is an array or slice, the following adds will be appended to that list. +For single values, `Add` accepts values that support Go's `+` operator. If the first `Add` for a key is an array or slice, the following adds will be [appended](/functions/append/) to that list. ```go-html-template {{ $scratch.Add "greetings" "Hello" }} diff --git a/docs/content/en/functions/strings.ContainsNonSpace.md b/docs/content/en/functions/strings.ContainsNonSpace.md new file mode 100644 index 00000000000..eafe292f5bb --- /dev/null +++ b/docs/content/en/functions/strings.ContainsNonSpace.md @@ -0,0 +1,27 @@ +--- +title: strings.ContainsNonSpace +description: Reports whether a string contains any non-space characters as defined by Unicode’s White Space property. +categories: [functions] +menu: + docs: + parent: functions +keywords: [whitespace space] +signature: ["strings.ContainsNonSpace STRING"] +relatedfuncs: ["strings.Contains","strings.ContainsAny"] +--- + +```go-html-template +{{ strings.ContainsNonSpace "\n" }} → false +{{ strings.ContainsNonSpace " " }} → false +{{ strings.ContainsNonSpace "\n abc" }} → true +``` + +Common white space characters include: + +```text +'\t', '\n', '\v', '\f', '\r', ' ' +``` + +See the [Unicode Character Database] for a complete list. + +[Unicode Character Database]: https://www.unicode.org/Public/UCD/latest/ucd/PropList.txt diff --git a/docs/content/en/functions/transform.Unmarshal.md b/docs/content/en/functions/transform.Unmarshal.md index ca54337619c..7d0920da8fb 100644 --- a/docs/content/en/functions/transform.Unmarshal.md +++ b/docs/content/en/functions/transform.Unmarshal.md @@ -62,12 +62,12 @@ The following example lists the items of an RSS feed: ```go-html-template {{ with resources.GetRemote "https://example.com/rss.xml" | transform.Unmarshal }} - {{ range .channel.item }} - {{ .title | plainify | htmlUnescape }}
-

{{ .description | plainify | htmlUnescape }}

- {{ $link := .link | plainify | htmlUnescape }} - {{ $link }}
-
- {{ end }} + {{ range .channel.item }} + {{ .title | plainify | htmlUnescape }}
+

{{ .description | plainify | htmlUnescape }}

+ {{ $link := .link | plainify | htmlUnescape }} + {{ $link }}
+
+ {{ end }} {{ end }} ``` diff --git a/docs/content/en/functions/uniq.md b/docs/content/en/functions/uniq.md index 4584ec5ad77..aecdccf9542 100644 --- a/docs/content/en/functions/uniq.md +++ b/docs/content/en/functions/uniq.md @@ -11,5 +11,5 @@ signature: [uniq SET] ```go-html-template -{{ slice 1 3 2 1 | uniq }} --> [1 3 2] +{{ slice 1 3 2 1 | uniq }} → [1 3 2] ``` diff --git a/docs/content/en/functions/urlize.md b/docs/content/en/functions/urlize.md index 8c9aeb1c370..7a9cf25e8db 100644 --- a/docs/content/en/functions/urlize.md +++ b/docs/content/en/functions/urlize.md @@ -22,20 +22,20 @@ The following might be used as a partial within a [single page template][singlet {{< code file="layouts/partials/content-header.html" >}}
-

{{ .Title }}

- {{ with .Params.location }} -
{{ . }}
- {{ end }} - - {{ with .Params.tags }} +

{{ .Title }}

+ {{ with .Params.location }} +
{{ . }}
+ {{ end }} + + {{ with .Params.tags }} - {{ end }} + {{ end }}
{{< /code >}} diff --git a/docs/content/en/functions/where.md b/docs/content/en/functions/where.md index f2e2642359e..9618ea4c639 100644 --- a/docs/content/en/functions/where.md +++ b/docs/content/en/functions/where.md @@ -109,25 +109,12 @@ You can also put the returned value of the `where` clauses into a variable: This example matches pages where the "foo" parameter begins with "ab": ```go-html-template -{{ range where site.RegularPages "Params.foo" "like" "^ab" }} +{{ range where site.RegularPages "Params.foo" "like" `^ab` }}

{{ .LinkTitle }}

{{ end }} ``` -When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. - -[string literal]: https://go.dev/ref/spec#String_literals - -Go's regular expression package implements the [RE2 syntax]. Note that the RE2 `\C` escape sequence is not supported. - -[RE2 syntax]: https://github.com/google/re2/wiki/Syntax/ - -{{% note %}} -The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. - -[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats -[PCRE]: https://www.pcre.org/ -{{% /note %}} +{{% readfile file="/functions/common/regular-expressions.md" %}} ## Use `where` with `first` diff --git a/docs/content/en/getting-started/configuration.md b/docs/content/en/getting-started/configuration.md index 21f4eb67f1f..ea82f1b53be 100644 --- a/docs/content/en/getting-started/configuration.md +++ b/docs/content/en/getting-started/configuration.md @@ -168,7 +168,7 @@ Pass down default configuration values (front matter) to pages in the content tr **Default value:** false -Enable to turn relative URLs into absolute. +Enable to turn relative URLs into absolute. See [details](/content-management/urls/#canonical-urls). ### cleanDestinationDir @@ -381,7 +381,7 @@ See [Related Content](/content-management/related/#configure-related-content). **Default value:** false -Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. +Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. See [details](/content-management/urls/#relative-urls). ### refLinksErrorLevel @@ -517,7 +517,7 @@ The `build` configuration section contains global build-related configuration op buildStats {{< new-in "0.115.1" >}} : When enabled, creates a `hugo_stats.json` file in the root of your project. This file contains arrays of the `class` attributes, `id` attributes, and tags of every HTML element within your published site. Use this file as data source when [removing unused CSS] from your site. This process is also known as pruning, purging, or tree shaking. -[removing unused CSS]: http://localhost:1313/hugo-pipes/postprocess/#css-purging-with-postcss +[removing unused CSS]: /hugo-pipes/postprocess/#css-purging-with-postcss Exclude `class` attributes, `id` attributes, or tags from `hugo_stats.json` with the `disableClasses`, `disableIDs`, and `disableTags` keys. @@ -864,7 +864,7 @@ This can be set using the `cacheDir` config option or via the OS env variable `H If this is not set, Hugo will use, in order of preference: 1. If running on Netlify: `/opt/build/cache/hugo_cache/`. This means that if you run your builds on Netlify, all caches configured with `:cacheDir` will be saved and restored on the next build. For other CI vendors, please read their documentation. For an CircleCI example, see [this configuration](https://github.com/bep/hugo-sass-test/blob/6c3960a8f4b90e8938228688bc49bdcdd6b2d99e/.circleci/config.yml). -1. In a `hugo_cache` directory below the OS user cache directory as defined by Go's [os.UserCacheDir](https://pkg.go.dev/os#UserCacheDir). On Unix systems, this is `$XDG_CONFIG_HOME` as specified by [basedir-spec-latest](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) if non-empty, else `$HOME/.config`. On MacOS, this is `$HOME/Library/Application Support`. On Windows, this is`%AppData%`. On Plan 9, this is `$home/lib`. {{< new-in "0.116.0" >}} +1. In a `hugo_cache` directory below the OS user cache directory as defined by Go's [os.UserCacheDir](https://pkg.go.dev/os#UserCacheDir). On Unix systems, this is `$XDG_CACHE_HOME` as specified by [basedir-spec-latest](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) if non-empty, else `$HOME/.cache`. On MacOS, this is `$HOME/Library/Caches`. On Windows, this is`%LocalAppData%`. On Plan 9, this is `$home/lib/cache`. {{< new-in "0.116.0" >}} 1. In a `hugo_cache_$USER` directory below the OS temp dir. -If you want to know the current value of `cacheDir`, you can run `hugo config`, e.g: `hugo config | grep cachedir`. \ No newline at end of file +If you want to know the current value of `cacheDir`, you can run `hugo config`, e.g: `hugo config | grep cachedir`. diff --git a/docs/content/en/hosting-and-deployment/hosting-on-github/index.md b/docs/content/en/hosting-and-deployment/hosting-on-github/index.md index 47a7074b70f..dd8bf5583e2 100644 --- a/docs/content/en/hosting-and-deployment/hosting-on-github/index.md +++ b/docs/content/en/hosting-and-deployment/hosting-on-github/index.md @@ -100,7 +100,7 @@ jobs: build: runs-on: ubuntu-latest env: - HUGO_VERSION: 0.115.1 + HUGO_VERSION: 0.115.4 steps: - name: Install Hugo CLI run: | diff --git a/docs/content/en/hosting-and-deployment/hosting-on-gitlab.md b/docs/content/en/hosting-and-deployment/hosting-on-gitlab.md index b48a392b7be..964e656ed06 100644 --- a/docs/content/en/hosting-and-deployment/hosting-on-gitlab.md +++ b/docs/content/en/hosting-and-deployment/hosting-on-gitlab.md @@ -27,8 +27,8 @@ Define your [CI/CD](https://docs.gitlab.com/ee/ci/quick_start/) jobs by creating {{< code file=".gitlab-ci.yml" >}} variables: - DART_SASS_VERSION: 1.63.6 - HUGO_VERSION: 0.115.3 + DART_SASS_VERSION: 1.64.1 + HUGO_VERSION: 0.115.4 NODE_VERSION: 20.x GIT_DEPTH: 0 GIT_STRATEGY: clone @@ -46,8 +46,9 @@ pages: # Install Dart Sass - curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz - tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz - - cp -r dart-sass/* /usr/local/bin + - cp -r dart-sass/ /usr/local/bin - rm -rf dart-sass* + - export PATH=/usr/local/bin/dart-sass:$PATH # Install Hugo - curl -LJO https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb - apt-get install -y ./hugo_extended_${HUGO_VERSION}_linux-amd64.deb diff --git a/docs/content/en/hosting-and-deployment/hosting-on-netlify.md b/docs/content/en/hosting-and-deployment/hosting-on-netlify.md index 00cc030429b..91d04475586 100644 --- a/docs/content/en/hosting-and-deployment/hosting-on-netlify.md +++ b/docs/content/en/hosting-and-deployment/hosting-on-netlify.md @@ -57,14 +57,14 @@ For production: {{< code file="netlify.toml" >}} [context.production.environment] - HUGO_VERSION = "0.99.1" + HUGO_VERSION = "0.115.4" {{< /code >}} For testing: {{< code file="netlify.toml" >}} [context.deploy-preview.environment] - HUGO_VERSION = "0.99.1" + HUGO_VERSION = "0.115.4" {{< /code >}} The Netlify configuration file can be a little hard to understand and get right for the different environment, and you may get some inspiration and tips from this site's `netlify.toml`: diff --git a/docs/content/en/installation/common/05-build-from-source.md b/docs/content/en/installation/common/05-build-from-source.md index c0bd85515b5..7537882fda0 100644 --- a/docs/content/en/installation/common/05-build-from-source.md +++ b/docs/content/en/installation/common/05-build-from-source.md @@ -1,20 +1,23 @@ ## Build from source -To build Hugo from source you must: +To build the extended edition of Hugo from source you must: 1. Install [Git] 1. Install [Go] version 1.19 or later -1. Update your PATH environment variable as described in the [Go documentation] +1. Install a C compiler, either [GCC] or [Clang] +1. Update your `PATH` environment variable as described in the [Go documentation] -> The install directory is controlled by the GOPATH and GOBIN environment variables. If GOBIN is set, binaries are installed to that directory. If GOPATH is set, binaries are installed to the bin subdirectory of the first directory in the GOPATH list. Otherwise, binaries are installed to the bin subdirectory of the default GOPATH ($HOME/go or %USERPROFILE%\go). +> The install directory is controlled by the `GOPATH` and `GOBIN` environment variables. If `GOBIN` is set, binaries are installed to that directory. If `GOPATH` is set, binaries are installed to the bin subdirectory of the first directory in the `GOPATH` list. Otherwise, binaries are installed to the bin subdirectory of the default `GOPATH` (`$HOME/go` or `%USERPROFILE%\go`). Then build and test: ```sh -go install -tags extended github.com/gohugoio/hugo@latest +CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest hugo version ``` +[Clang]: https://clang.llvm.org/ +[GCC]: https://gcc.gnu.org/ [Git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git -[Go]: https://go.dev/doc/install [Go documentation]: https://go.dev/doc/code#Command +[Go]: https://go.dev/doc/install diff --git a/docs/content/en/installation/linux.md b/docs/content/en/installation/linux.md index 11c6795f15f..4056b987a63 100644 --- a/docs/content/en/installation/linux.md +++ b/docs/content/en/installation/linux.md @@ -29,16 +29,18 @@ This will install the extended edition of Hugo: sudo snap install hugo ``` -To enable access to removable media: +To enable or revoke access to removable media: ```sh sudo snap connect hugo:removable-media +sudo snap disconnect hugo:removable-media ``` -To revoke access to removable media: +To enable or revoke access to SSH keys: ```sh -sudo snap disconnect hugo:removable-media +sudo snap connect hugo:ssh-keys +sudo snap disconnect hugo:ssh-keys ``` [most distributions]: https://snapcraft.io/docs/installing-snapd diff --git a/docs/content/en/installation/windows.md b/docs/content/en/installation/windows.md index 9959f590a56..92979d9f250 100644 --- a/docs/content/en/installation/windows.md +++ b/docs/content/en/installation/windows.md @@ -52,10 +52,7 @@ winget install Hugo.Hugo.Extended {{% readfile file="/installation/common/05-build-from-source.md" %}} {{% note %}} -When building the extended edition of Hugo from source on Windows, you will also need to install the [GCC compiler]. See these [detailed instructions]. - -[detailed instructions]: https://discourse.gohugo.io/t/41370 -[GCC compiler]: https://gcc.gnu.org/ +See these [detailed instructions](https://discourse.gohugo.io/t/41370) to install GCC on Windows. {{% /note %}} ## Comparison diff --git a/docs/content/en/news/0.25-relnotes/index.md b/docs/content/en/news/0.25-relnotes/index.md index 6ceef445d31..5ed0a2bc150 100644 --- a/docs/content/en/news/0.25-relnotes/index.md +++ b/docs/content/en/news/0.25-relnotes/index.md @@ -9,8 +9,6 @@ aliases: [/0-25/] Hugo `0.25` is the **Kinder Surprise**: It automatically opens the page you're working on in the browser, it adds full `AND` and `OR` support in page queries, and you can now have templates per language. -![Hugo Open on Save](https://cdn-standard5.discourse.org/uploads/gohugo/optimized/2X/6/622088d4a8eacaf62bbbaa27dab19d789e10fe09_1_690x345.gif "Hugo Open on Save") - If you start with `hugo server --navigateToChanged`, Hugo will navigate to the relevant page on save (see animated GIF). This is extremely useful for site-wide edits. Another very useful feature in this version is the added support for `AND` (`intersect`) and `OR` (`union`) filters when combined with `where`. Example: diff --git a/docs/content/en/templates/homepage.md b/docs/content/en/templates/homepage.md index 5fe6902d39c..a176a51f2ab 100644 --- a/docs/content/en/templates/homepage.md +++ b/docs/content/en/templates/homepage.md @@ -40,7 +40,7 @@ The following is an example of a homepage template that uses [partial][partials]

{{ .Title }}

{{ with .Params.subtitle }} - {{ . }} + {{ . }} {{ end }}
@@ -49,7 +49,7 @@ The following is an example of a homepage template that uses [partial][partials]
{{ range first 10 .Site.RegularPages }} - {{ .Render "summary" }} + {{ .Render "summary" }} {{ end }}
diff --git a/docs/content/en/templates/internal.md b/docs/content/en/templates/internal.md index 828244fa01c..ee0d7258db0 100644 --- a/docs/content/en/templates/internal.md +++ b/docs/content/en/templates/internal.md @@ -19,12 +19,12 @@ While the following internal templates are called similar to partials, they do * ## Google Analytics -Hugo ships with internal templates supporting Google Analytics, both [Google Analytics 4][GA4] (GA4) and Universal Analytics. +Hugo ships with an internal template supporting [Google Analytics 4][GA4] (GA4). -**Note:** Universal Analytics are deprecated. For details, see [Universal Analytics will be going away]. +**Note:** Universal Analytics are [deprecated]. [GA4]: https://support.google.com/analytics/answer/10089681 -[Universal Analytics will be going away]: https://support.google.com/analytics/answer/11583528 +[deprecated]: https://support.google.com/analytics/answer/11583528 ### Configure Google Analytics @@ -35,40 +35,29 @@ Provide your tracking ID in your configuration file: googleAnalytics = "G-MEASUREMENT_ID" {{}} -**Google Universal Analytics (analytics.js)** -{{< code-toggle file="hugo" >}} -googleAnalytics = "UA-PROPERTY_ID" -{{}} - ### Use the Google Analytics template -You can then include the Google Analytics internal template: - -```go-html-template -{{ template "_internal/google_analytics_async.html" . }} -``` - -**Note:** The async template is _not_ suitable for Google Analytics 4. +Include the Google Analytics internal template in your templates where you want the code to appear: ```go-html-template {{ template "_internal/google_analytics.html" . }} ``` -If you want to create your own template, you can access the configured ID with `{{ site.Config.Services.GoogleAnalytics.ID }}`. +To create your own template, access the configured ID with `{{ site.Config.Services.GoogleAnalytics.ID }}`. ## Disqus -Hugo also ships with an internal template for [Disqus comments][disqus], a popular commenting system for both static and dynamic websites. In order to effectively use Disqus, you will need to secure a Disqus "shortname" by [signing up for the free service][disqussignup]. +Hugo also ships with an internal template for [Disqus comments][disqus], a popular commenting system for both static and dynamic websites. To effectively use Disqus, secure a Disqus "shortname" by [signing up for the free service][disqussignup]. ### Configure Disqus -To use Hugo's Disqus template, you first need to set a single configuration value: +To use Hugo's Disqus template, first set up a single configuration value: {{< code-toggle file="hugo" >}} disqusShortname = "your-disqus-shortname" {{}} -You also have the option to set the following in the front matter for a given piece of content: +You can also set the following in the front matter for a given piece of content: * `disqus_identifier` * `disqus_title` @@ -76,7 +65,7 @@ You also have the option to set the following in the front matter for a given pi ### Use the Disqus template -To add Disqus, include the following line in templates where you want your comments to appear: +To add Disqus, include the following line in the templates where you want your comments to appear: ```go-html-template {{ template "_internal/disqus.html" . }} @@ -222,7 +211,6 @@ The code for these templates is located [here](https://github.com/gohugoio/hugo/ * `_internal/disqus.html` * `_internal/google_analytics.html` -* `_internal/google_analytics_async.html` * `_internal/opengraph.html` * `_internal/pagination.html` * `_internal/schema.html` diff --git a/docs/content/en/templates/lists/index.md b/docs/content/en/templates/lists/index.md index 204cbcbcc07..ec397c32bec 100644 --- a/docs/content/en/templates/lists/index.md +++ b/docs/content/en/templates/lists/index.md @@ -166,13 +166,13 @@ This list template has been modified slightly from a template originally used in {{ partial "subheader.html" . }}
-

{{ .Title }}

- +

{{ .Title }}

+
{{ partial "footer.html" . }} @@ -184,10 +184,10 @@ This list template has been modified slightly from a template originally used in {{ define "main" }}
-

{{ .Title }}

- +

{{ .Title }}

+ {{ range .Pages }} - {{ .Render "summary" }} + {{ .Render "summary" }} {{ end }}
diff --git a/docs/content/en/templates/section-templates.md b/docs/content/en/templates/section-templates.md index db8ffd6677f..55a6c3004a9 100644 --- a/docs/content/en/templates/section-templates.md +++ b/docs/content/en/templates/section-templates.md @@ -46,17 +46,17 @@ Examples: {{< code file="layouts/_default/section.html" >}} {{ define "main" }}
- {{ .Content }} - - {{ partial "pagination.html" . }} + {{ .Content }} + + {{ partial "pagination.html" . }}
{{ end }} {{< /code >}} diff --git a/docs/content/en/templates/shortcode-templates.md b/docs/content/en/templates/shortcode-templates.md index f293b6d5277..6a6700380d8 100644 --- a/docs/content/en/templates/shortcode-templates.md +++ b/docs/content/en/templates/shortcode-templates.md @@ -94,7 +94,13 @@ most helpful when the condition depends on either of the values, or both: #### `.Inner` -If a closing shortcode is used, the `.Inner` variable will be populated with the content between the opening and closing shortcodes. If a closing shortcode is required, you can check the length of `.Inner` as an indicator of its existence. +If a closing shortcode is used, the `.Inner` variable will be populated with the content between the opening and closing shortcodes. To check if `.Inner` contains anything other than white space: + +```go-html-template +{{ if strings.ContainsNonSpace .Inner }} + Inner is not empty +{{ end }} +``` A shortcode with content declared via the `.Inner` variable can also be declared without the content and without the closing tag by using the self-closing syntax: diff --git a/docs/content/en/templates/single-page-templates.md b/docs/content/en/templates/single-page-templates.md index 861ced99d36..12e04db96a0 100644 --- a/docs/content/en/templates/single-page-templates.md +++ b/docs/content/en/templates/single-page-templates.md @@ -36,10 +36,10 @@ This single page template makes use of Hugo [base templates], the [`.Format` fun