diff --git a/docs/content/en/configuration/introduction.md b/docs/content/en/configuration/introduction.md index 121a483c4..8f8ad4c1e 100644 --- a/docs/content/en/configuration/introduction.md +++ b/docs/content/en/configuration/introduction.md @@ -249,7 +249,7 @@ HUGO_FILE_LOG_FORMAT HUGO_MEMORYLIMIT : {{< new-in 0.123.0 />}} -: (`int`) The maximum amount of system memory, in gigabytes, that Hugo can use while rendering your site. Default is 25% of total system memory. Note that The `HUGO_MEMORYLIMIT` is a “best effort” setting. Don't expect Hugo to build a million pages with only 1 GB memory. You can get more information about how this behaves during the build by building with `hugo --logLevel info` and look for the `dynacache` label. +: (`int`) The maximum amount of system memory, in gigabytes, that Hugo can use while rendering your site. Default is 25% of total system memory. Note that `HUGO_MEMORYLIMIT` is a "best effort" setting. Don't expect Hugo to build a million pages with only 1 GB of memory. You can get more information about how this behaves during the build by building with `hugo --logLevel info` and look for the `dynacache` label. HUGO_NUMWORKERMULTIPLIER : (`int`) The number of workers used in parallel processing. Default is the number of logical CPUs. diff --git a/docs/content/en/content-management/menus.md b/docs/content/en/content-management/menus.md index ab1bcbfa1..6d01173dc 100644 --- a/docs/content/en/content-management/menus.md +++ b/docs/content/en/content-management/menus.md @@ -11,7 +11,7 @@ aliases: [/extras/menus/] To create a menu for your site: 1. Define the menu entries -1. [Localize] each entry +1. [Localize](multilingual/#menus) each entry 1. Render the menu with a [template] Create multiple menus, either flat or nested. For example, create a main menu for the header, and a separate menu for the footer. diff --git a/docs/content/en/contribute/documentation.md b/docs/content/en/contribute/documentation.md index 1d185d21d..68129912a 100644 --- a/docs/content/en/contribute/documentation.md +++ b/docs/content/en/contribute/documentation.md @@ -112,7 +112,7 @@ Yes → Hugo is fast. ### Function and method descriptions -Start descriptions in the functions and methods sections with "Returns", of for booelan values, "Reports whether". +Start descriptions in the functions and methods sections with "Returns", or for boolean values, "Reports whether". ### File paths and names diff --git a/docs/content/en/functions/collections/Where.md b/docs/content/en/functions/collections/Where.md index 1df84afc4..84fd1d21e 100644 --- a/docs/content/en/functions/collections/Where.md +++ b/docs/content/en/functions/collections/Where.md @@ -87,7 +87,6 @@ Use any of the following logical operators: : (`bool`) Reports whether the given field value (a slice) contains one or more elements in common with `VALUE`. See [details](/functions/collections/intersect). `like` -: {{< new-in 0.116.0 />}} : (`bool`) Reports whether the given field value matches the [regular expression](g) specified in `VALUE`. Use the `like` operator to compare `string` values. The `like` operator returns `false` when comparing other data types to the regular expression. > [!note] @@ -167,8 +166,6 @@ For example, to return a collection of pages where any of the terms in the "genr ## Regular expression comparison -{{< new-in 0.116.0 />}} - To return a collection of pages where the "author" page parameter begins with either "victor" or "Victor": ```go-html-template diff --git a/docs/content/en/functions/css/Sass.md b/docs/content/en/functions/css/Sass.md index 1d5487130..03a4c7451 100644 --- a/docs/content/en/functions/css/Sass.md +++ b/docs/content/en/functions/css/Sass.md @@ -12,13 +12,66 @@ params: {{< new-in 0.128.0 />}} -```go-html-template +Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended and extended/deploy editions, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language. + +Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both. + +[scss]: https://sass-lang.com/documentation/syntax#scss +[indented]: https://sass-lang.com/documentation/syntax#the-indented-syntax + +## Options + +enableSourceMap +: (`bool`) Whether to generate a source map. Default is `false`. + +includePaths +: (`slice`) A slice of paths, relative to the project root, that the transpiler will use when resolving `@use` and `@import` statements. + +outputStyle +: (`string`) The output style of the resulting CSS. With LibSass, one of `nested` (default), `expanded`, `compact`, or `compressed`. With Dart Sass, either `expanded` (default) or `compressed`. + +precision +: (`int`) The precision of floating point math. Applicable to LibSass. Default is `8`. + +silenceDeprecations +: {{< new-in 0.139.0 />}} +: (`slice`) A slice of deprecation IDs to silence. IDs are enclosed in brackets within Dart Sass warning messages (e.g., `import` in `WARN Dart Sass: DEPRECATED [import]`). Applicable to Dart Sass. Default is `false`. + +silenceDependencyDeprecations +: {{< new-in 0.146.0 />}} +: (`bool`) Whether to silence deprecation warnings from dependencies, where a dependency is considered any file transitively imported through a load path. This does not apply to `@warn` or `@debug` rules.Default is `false`. + +sourceMapIncludeSources +: (`bool`) Whether to embed sources in the generated source map. Applicable to Dart Sass. Default is `false`. + +targetPath +: (`string`) The publish path for the transformed resource, relative to the[`publishDir`]. If unset, the target path defaults to the asset's original path with a `.css` extension. + +transpiler +: (`string`) The transpiler to use, either `libsass` or `dartsass`. Hugo's extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass). Default is `libsass`. + +vars +: (`map`) A map of key-value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/). + + ```scss + // LibSass + @import "hugo:vars"; + + // Dart Sass + @use "hugo:vars" as v; + ``` + +## Example + +```go-html-template {copy=true} {{ with resources.Get "sass/main.scss" }} {{ $opts := dict "enableSourceMap" (not hugo.IsProduction) "outputStyle" (cond hugo.IsProduction "compressed" "expanded") "targetPath" "css/main.css" - "transpiler" "libsass" + "transpiler" "dartsass" + "vars" site.Params.styles + "includePaths" (slice "node_modules/bootstrap/scss") }} {{ with . | toCSS $opts }} {{ if hugo.IsProduction }} @@ -32,63 +85,6 @@ params: {{ end }} ``` -Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended and extended/deploy editions, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language. - -Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both. - -[scss]: https://sass-lang.com/documentation/syntax#scss -[indented]: https://sass-lang.com/documentation/syntax#the-indented-syntax - -## Options - -transpiler -: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below. - -targetPath -: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`. - -vars -: (`map`) A map of key-value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/). - -```scss -// LibSass -@import "hugo:vars"; - -// Dart Sass -@use "hugo:vars" as v; -``` - -outputStyle -: (`string`) Output styles available to LibSass include `nested` (default), `expanded`, `compact`, and `compressed`. Output styles available to Dart Sass include `expanded` (default) and `compressed`. - -precision -: (`int`) Precision of floating point math. Not applicable to Dart Sass. - -enableSourceMap -: (`bool`) Whether to generate a source map. Default is `false`. - -sourceMapIncludeSources -: (`bool`) Whether to embed sources in the generated source map. Not applicable to LibSass. Default is `false`. - -includePaths -: (`slice`) A slice of paths, relative to the project root, that the transpiler will use when resolving `@use` and `@import` statements. - -```go-html-template -{{ $opts := dict - "transpiler" "dartsass" - "targetPath" "css/style.css" - "vars" site.Params.styles - "enableSourceMap" (not hugo.IsProduction) - "includePaths" (slice "node_modules/bootstrap/scss") -}} -{{ with resources.Get "sass/main.scss" | toCSS $opts | minify | fingerprint }} - -{{ end }} -``` - -silenceDeprecations -: (`slice`) {{< new-in 0.139.0 />}} A slice of deprecation IDs to silence. The deprecation IDs are printed to in the warning message, e.g "import" in `WARN Dart Sass: DEPRECATED [import] ...`. This is for Dart Sass only. - ## Dart Sass Hugo's extended and extended/deploy editions include [LibSass] to transpile Sass to CSS. In 2020, the Sass team deprecated LibSass in favor of [Dart Sass]. @@ -121,6 +117,9 @@ You may also install [prebuilt binaries] for Linux, macOS, and Windows. Run `hugo env` to list the active transpilers. +> [!note] +> If you build Hugo from source and run `mage test -v`, the test will fail if you install Dart Sass as a Snap package. This is due to the Snap package's strict confinement model. + ### Installing in a production environment For [CI/CD](g) deployments (e.g., GitHub Pages, GitLab Pages, Netlify, etc.) you must edit the workflow to install Dart Sass before Hugo builds the site[^2]. Some providers allow you to use one of the package managers above, or you can download and extract one of the prebuilt binaries. @@ -136,8 +135,6 @@ To install Dart Sass for your builds on GitHub Pages, add this step to the GitHu run: sudo snap install dart-sass ``` -If you are using GitHub Pages for the first time with your repository, GitHub provides a [starter workflow] for Hugo that includes Dart Sass. This is the simplest way to get started. - #### GitLab Pages To install Dart Sass for your builds on GitLab Pages, the `.gitlab-ci.yml` file should look something like this: @@ -194,34 +191,6 @@ command = """\ """ ``` -### Example - -To transpile with Dart Sass, set `transpiler` to `dartsass` in the options map passed to `css.Sass`. For example: - -```go-html-template -{{ with resources.Get "sass/main.scss" }} - {{ $opts := dict - "enableSourceMap" (not hugo.IsProduction) - "outputStyle" (cond hugo.IsProduction "compressed" "expanded") - "targetPath" "css/main.css" - "transpiler" "dartsass" - }} - {{ with . | toCSS $opts }} - {{ if hugo.IsProduction }} - {{ with . | fingerprint }} - - {{ end }} - {{ else }} - - {{ end }} - {{ end }} -{{ end }} -``` - -### Miscellaneous - -If you build Hugo from source and run `mage test -v`, the test will fail if you install Dart Sass as a Snap package. This is due to the Snap package's strict confinement model. - [brew.sh]: https://brew.sh/ [chocolatey.org]: https://community.chocolatey.org/packages/sass [dart sass]: https://sass-lang.com/dart-sass @@ -232,3 +201,4 @@ If you build Hugo from source and run `mage test -v`, the test will fail if you [snap package]: /installation/linux/#snap [snapcraft.io]: https://snapcraft.io/dart-sass [starter workflow]: https://github.com/actions/starter-workflows/blob/main/pages/hugo.yml +[`publishDir`]: /configuration/all/#publishdir diff --git a/docs/content/en/functions/go-template/template.md b/docs/content/en/functions/go-template/template.md index dac1fa3be..053cfcc22 100644 --- a/docs/content/en/functions/go-template/template.md +++ b/docs/content/en/functions/go-template/template.md @@ -10,7 +10,18 @@ params: signatures: ['template NAME [CONTEXT]'] --- -Use the `template` function to execute [embedded templates]. For example: +Use the `template` function to execute any of these [embedded templates](g): + +- [`disqus.html`] +- [`google_analytics.html`] +- [`opengraph.html`] +- [`pagination.html`] +- [`schema.html`] +- [`twitter_cards.html`] + + + +For example: ```go-html-template {{ range (.Paginate .Pages).Pages }} @@ -39,8 +50,21 @@ The example above can be rewritten using an [inline partial] template: {{ end }} ``` +The key distinctions between the preceding two examples are: + +1. Inline partials are globally scoped. That means that an inline partial defined in _one_ template may be called from _any_ template. +2. Leveraging the [`partialCached`] function when calling an inline partial allows for performance optimization through result caching. +3. An inline partial can [`return`] a value of any data type instead of rendering a string. + {{% include "/_common/functions/go-template/text-template.md" %}} +[`disqus.html`]: /templates/embedded/#disqus +[`google_analytics.html`]: /templates/embedded/#google-analytics +[`opengraph.html`]: /templates/embedded/#open-graph +[`pagination.html`]: /templates/embedded/#pagination +[`partialCached`]: /functions/partials/includecached/ [`partial`]: /functions/partials/include/ +[`return`]: /functions/go-template/return/ +[`schema.html`]: /templates/embedded/#schema +[`twitter_cards.html`]: /templates/embedded/#x-twitter-cards [inline partial]: /templates/partial/#inline-partials -[embedded templates]: /templates/embedded/ diff --git a/docs/content/en/functions/templates/Current.md b/docs/content/en/functions/templates/Current.md new file mode 100644 index 000000000..805aeec05 --- /dev/null +++ b/docs/content/en/functions/templates/Current.md @@ -0,0 +1,155 @@ +--- +title: templates.Current +description: Returns information about the currently executing template. +categories: [] +keywords: [] +params: + functions_and_methods: + aliases: [] + returnType: tpl.CurrentTemplateInfo + signatures: [templates.Current] +--- + +> [!note] +> This function is experimental and subject to change. + +{{< new-in 0.146.0 />}} + +The `templates.Current` function provides introspection capabilities, allowing you to access details about the currently executing templates. This is useful for debugging complex template hierarchies and understanding the flow of execution during rendering. + +## Methods + +Ancestors +: (`tpl.CurrentTemplateInfos`) Returns a slice containing information about each template in the current execution chain, starting from the parent of the current template and going up towards the initial template called. It excludes any base template applied via `define` and `block`. You can chain the `Reverse` method to this result to get the slice in chronological execution order. + +Base +: (`tpl.CurrentTemplateInfoCommonOps`) Returns an object representing the base template that was applied to the current template, if any. This may be `nil`. + +Filename +: (`string`) Returns the absolute path of the current template. This will be empty for embedded templates. + +Name +: (`string`) Returns the name of the current template. This is usually the path relative to the layouts directory. + +Parent +: (`tpl.CurrentTemplateInfo`) Returns an object representing the parent of the current template, if any. This may be `nil`. + +## Examples + +The examples below help visualize template execution and require a `debug` parameter set to `true` in your site configuration: + +{{< code-toggle file=hugo >}} +[params] +debug = true +{{< /code-toggle >}} + +### Boundaries + +To visually mark where a template begins and ends execution: + +```go-html-template {file="layouts/_default/single.html"} +{{ define "main" }} + {{ if site.Params.debug }} +
[entering {{ templates.Current.Filename }}]
+ {{ end }} + +

{{ .Title }}

+ {{ .Content }} + + {{ if site.Params.debug }} +
[leaving {{ templates.Current.Filename }}]
+ {{ end }} +{{ end }} +``` + +### Call stack + +To display the chain of templates that led to the current one, create a partial template that iterates through its ancestors: + +```go-html-template {file="layouts/partials/template-call-stack.html" copy=true} +{{ with templates.Current }} +
+ {{ range .Ancestors }} + {{ .Filename }}
+ {{ with .Base }} + {{ .Filename }}
+ {{ end }} + {{ end }} +
+{{ end }} +``` + +Then call the partial from any template: + +```go-html-template {file="layouts/partials/footer/copyright.html" copy=true} +{{ if site.Params.debug }} + {{ partial "template-call-stack.html" . }} +{{ end }} +``` + +The rendered template stack would look something like this: + +```text +/home/user/project/layouts/partials/footer/copyright.html +/home/user/project/themes/foo/layouts/partials/footer.html +/home/user/project/layouts/_default/single.html +/home/user/project/themes/foo/layouts/_default/baseof.html +``` + +To reverse the order of the entries, chain the `Reverse` method to the `Ancestors` method: + +```go-html-template {file="layouts/partials/template-call-stack.html" copy=true} +{{ with templates.Current }} +
+ {{ range .Ancestors.Reverse }} + {{ with .Base }} + {{ .Filename }}
+ {{ end }} + {{ .Filename }}
+ {{ end }} +
+{{ end }} +``` + +### VS Code + +To render links that, when clicked, will open the template in Microsoft Visual Studio Code, create a partial template with anchor elements that use the `vscode` URI scheme: + +```go-html-template {file="layouts/partials/template-open-in-vs-code.html" copy=true} +{{ with templates.Current.Parent }} +
+ {{ .Name }} + {{ with .Base }} + {{ .Name }} + {{ end }} +
+{{ end }} +``` + +Then call the partial from any template: + +```go-html-template {file="layouts/_default/single.html" copy=true} +{{ define "main" }} +

{{ .Title }}

+ {{ .Content }} + + {{ if site.Params.debug }} + {{ partial "template-open-in-vs-code.html" . }} + {{ end }} +{{ end }} +``` + +Use the same approach to render the entire call stack as links: + +```go-html-template {file="layouts/partials/template-call-stack.html" copy=true} +{{ with templates.Current }} +
+ {{ range .Ancestors }} + {{ .Filename }}
+ {{ with .Base }} + {{ .Filename }}
+ {{ end }} + {{ end }} +
+{{ end }} +``` diff --git a/docs/content/en/functions/time/In.md b/docs/content/en/functions/time/In.md new file mode 100644 index 000000000..821eb99b7 --- /dev/null +++ b/docs/content/en/functions/time/In.md @@ -0,0 +1,30 @@ +--- +title: time.In +description: Returns the given date/time as represented in the specified IANA time zone. +categories: [] +keywords: [] +params: + functions_and_methods: + aliases: [] + returnType: time.Time + signatures: [time.In TIMEZONE INPUT] +--- + +{{< new-in 0.146.0 />}} + +The `time.In` function returns the given date/time as represented in the specified [IANA](g) time zone. + +- If the time zone is an empty string or `UTC`, the time is returned in [UTC](g). +- If the time zone is `Local`, the time is returned in the system's local time zone. +- Otherwise, the time zone must be a valid IANA [time zone name]. + +[time zone name]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List + +```go-html-template +{{ $layout := "2006-01-02T15:04:05-07:00" }} +{{ $t := time.AsTime "2025-03-31T14:45:00-00:00" }} + +{{ $t | time.In "America/Denver" | time.Format $layout }} → 2025-03-31T08:45:00-06:00 +{{ $t | time.In "Australia/Adelaide" | time.Format $layout }} → 2025-04-01T01:15:00+10:30 +{{ $t | time.In "Europe/Oslo" | time.Format $layout }} → 2025-03-31T16:45:00+02:00 +``` diff --git a/docs/content/en/functions/transform/Unmarshal.md b/docs/content/en/functions/transform/Unmarshal.md index d159122f5..93168294c 100644 --- a/docs/content/en/functions/transform/Unmarshal.md +++ b/docs/content/en/functions/transform/Unmarshal.md @@ -114,12 +114,14 @@ A remote resource is a file on a remote server, accessible via HTTP or HTTPS. > > `{{ $data = .Content | transform.Unmarshal }}` -## Options +## Working with CSV + +### Options When unmarshaling a CSV file, provide an optional map of options. delimiter -: (`string`) The delimiter used, default is `,`. +: (`string`) The delimiter used. Default is `,`. comment : (`string`) The comment character used in the CSV. If set, lines beginning with the comment character without preceding whitespace are ignored. @@ -128,8 +130,85 @@ lazyQuotes : {{< new-in 0.122.0 />}} : (`bool`) Whether to allow a quote in an unquoted field, or to allow a non-doubled quote in a quoted field. Default is `false`. +targetType +: {{< new-in 0.146.7 />}} +: (`string`) The target data type, either `slice` or `map`. Default is `slice`. + +### Examples + +The examples below use this CSV file: + +```csv +"name","type","breed","age" +"Spot","dog","Collie",3 +"Rover","dog","Boxer",5 +"Felix","cat","Calico",7 +``` + +To render an HTML table from a CSV file: + ```go-html-template -{{ $csv := "a;b;c" | transform.Unmarshal (dict "delimiter" ";") }} +{{ $data := slice }} +{{ $file := "pets.csv" }} +{{ with or (.Resources.Get $file) (resources.Get $file) }} + {{ $opts := dict "targetType" "slice" }} + {{ $data = transform.Unmarshal $opts . }} +{{ end }} + +{{ with $data }} + + + + {{ range index . 0 }} + + {{ end }} + + + + {{ range . | after 1 }} + + {{ range . }} + + {{ end }} + + {{ end }} + +
{{ . }}
{{ . }}
+{{ end }} +``` + +To extract a subset of the data, or to sort the data, unmarshal to a map instead of a slice: + +```go-html-template +{{ $data := slice }} +{{ $file := "pets.csv" }} +{{ with or (.Resources.Get $file) (resources.Get $file) }} + {{ $opts := dict "targetType" "map" }} + {{ $data = transform.Unmarshal $opts . }} +{{ end }} + +{{ with sort (where $data "type" "dog") "name" "asc" }} + + + + + + + + + + + {{ range . }} + + + + + + + {{ end }} + +
nametypebreedage
{{ .name }}{{ .type }}{{ .breed }}{{ .age }}
+{{ end }} ``` ## Working with XML diff --git a/docs/content/en/host-and-deploy/host-on-github-pages/index.md b/docs/content/en/host-and-deploy/host-on-github-pages/index.md index 4c00fbc8e..7c3201099 100644 --- a/docs/content/en/host-and-deploy/host-on-github-pages/index.md +++ b/docs/content/en/host-and-deploy/host-on-github-pages/index.md @@ -136,6 +136,8 @@ jobs: key: hugo-${{ github.run_id }} restore-keys: hugo- + - name: Configure Git + run: git config core.quotepath false - name: Build with Hugo run: | hugo \ diff --git a/docs/content/en/host-and-deploy/host-on-gitlab-pages.md b/docs/content/en/host-and-deploy/host-on-gitlab-pages.md index 4b308cc19..4750b0ff3 100644 --- a/docs/content/en/host-and-deploy/host-on-gitlab-pages.md +++ b/docs/content/en/host-and-deploy/host-on-gitlab-pages.md @@ -23,15 +23,15 @@ Define your [CI/CD](g) jobs by creating a `.gitlab-ci.yml` file in the root of y ```yaml {file=".gitlab-ci.yml" copy=true} variables: - DART_SASS_VERSION: 1.85.0 + DART_SASS_VERSION: 1.87.0 GIT_DEPTH: 0 GIT_STRATEGY: clone GIT_SUBMODULE_STRATEGY: recursive - HUGO_VERSION: 0.144.2 - NODE_VERSION: 23.x + HUGO_VERSION: 0.146.7 + NODE_VERSION: 22.x TZ: America/Los_Angeles image: - name: golang:1.23.4-bookworm + name: golang:1.24.2-bookworm pages: script: @@ -53,6 +53,8 @@ pages: - apt-get install -y nodejs # Install Node.js dependencies - "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" + # Configure Git + - git config core.quotepath false # Build - hugo --gc --minify --baseURL ${CI_PAGES_URL} # Compress diff --git a/docs/content/en/host-and-deploy/host-on-netlify/index.md b/docs/content/en/host-and-deploy/host-on-netlify/index.md index f3601331a..4c89a6c1e 100644 --- a/docs/content/en/host-and-deploy/host-on-netlify/index.md +++ b/docs/content/en/host-and-deploy/host-on-netlify/index.md @@ -113,21 +113,23 @@ Create a new file named netlify.toml in the root of your project directory. In i ```toml {file="netlify.toml"} [build.environment] -HUGO_VERSION = "0.144.2" +GO_VERSION = "1.24" +HUGO_VERSION = "0.146.7" NODE_VERSION = "22" TZ = "America/Los_Angeles" [build] publish = "public" -command = "hugo --gc --minify" +command = "git config core.quotepath false && hugo --gc --minify" ``` If your site requires Dart Sass to transpile Sass to CSS, the configuration file should look something like this: ```toml {file="netlify.toml"} [build.environment] -HUGO_VERSION = "0.144.2" -DART_SASS_VERSION = "1.85.0" +DART_SASS_VERSION = "1.87.0" +GO_VERSION = "1.24" +HUGO_VERSION = "0.146.7" NODE_VERSION = "22" TZ = "America/Los_Angeles" @@ -138,6 +140,7 @@ command = """\ tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \ rm dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \ export PATH=/opt/build/repo/dart-sass:$PATH && \ + git config core.quotepath false && \ hugo --gc --minify \ """ ``` diff --git a/docs/content/en/installation/linux.md b/docs/content/en/installation/linux.md index 731cfce4c..591bf0818 100644 --- a/docs/content/en/installation/linux.md +++ b/docs/content/en/installation/linux.md @@ -30,17 +30,33 @@ To install the extended edition of Hugo: sudo snap install hugo ``` -To enable or revoke access to removable media: +To control automatic updates: ```sh +# disable automatic updates +sudo snap refresh --hold hugo + +# enable automatic updates +sudo snap refresh --unhold hugo +``` + +To control access to removable media: + +```sh +# allow access sudo snap connect hugo:removable-media + +# revoke access sudo snap disconnect hugo:removable-media ``` -To enable or revoke access to SSH keys: +To control access to SSH keys: ```sh +# allow access sudo snap connect hugo:ssh-keys + +# revoke access sudo snap disconnect hugo:ssh-keys ``` diff --git a/docs/content/en/news/_content.gotmpl b/docs/content/en/news/_content.gotmpl index f979c9adc..af3cf47ed 100644 --- a/docs/content/en/news/_content.gotmpl +++ b/docs/content/en/news/_content.gotmpl @@ -23,7 +23,8 @@ "dates" $dates "kind" "page" "params" $params - "path" .name + "path" (strings.Replace .name "." "-") + "slug" .name "title" (printf "Release %s" .name) }} {{ $.AddPage $page }} diff --git a/docs/content/en/quick-reference/glossary/iana.md b/docs/content/en/quick-reference/glossary/iana.md new file mode 100644 index 000000000..89497f76a --- /dev/null +++ b/docs/content/en/quick-reference/glossary/iana.md @@ -0,0 +1,6 @@ +--- +title: IANA +reference: https://www.iana.org/about +--- + +_IANA_ is an abbreviation for the Internet Assigned Numbers Authority, a non-profit organization that manages the allocation of global IP addresses, autonomous system numbers, DNS root zone, media types, and other Internet Protocol-related resources. diff --git a/docs/content/en/quick-reference/glossary/utc.md b/docs/content/en/quick-reference/glossary/utc.md new file mode 100644 index 000000000..a4627be5a --- /dev/null +++ b/docs/content/en/quick-reference/glossary/utc.md @@ -0,0 +1,6 @@ +--- +title: UTC +reference: https://en.wikipedia.org/wiki/Coordinated_Universal_Time +--- + +_UTC_ is an abbreviation for Coordinated Universal Time, the primary time standard used worldwide to regulate clocks and time. It is the basis for civil time and time zones across the globe. diff --git a/docs/content/en/shortcodes/ref.md b/docs/content/en/shortcodes/ref.md index 2f821254c..a52c2bf6e 100755 --- a/docs/content/en/shortcodes/ref.md +++ b/docs/content/en/shortcodes/ref.md @@ -10,7 +10,7 @@ keywords: [] > To override Hugo's embedded `ref` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory. > [!note] -> When working with the Markdown [content format], this shortcode has become largely redundant. Its functionality is now primarily handled by [link render hooks], specifically the embedded one provided by Hugo. This hook effectively addresses all the use cases previously covered by this shortcode. +> When working with Markdown, this shortcode is obsolete. Instead, use a [link render hook] that resolves the link destination using the `GetPage` method on the `Page` object. You can either create your own, or simply enable the [embedded link render hook]. The embedded link render hook is automatically enabled for multilingual single-host projects. ## Usage @@ -56,6 +56,7 @@ Rendered: {{% include "_common/ref-and-relref-error-handling.md" %}} [content format]: /content-management/formats/ -[link render hooks]: /render-hooks/images/#default +[embedded link render hook]: /render-hooks/links/#default +[link render hook]: /render-hooks/links/ [Markdown notation]: /content-management/shortcodes/#notation -[source code]: {{% eturl ref %}} +[source code]: {{% eturl relref %}} diff --git a/docs/content/en/shortcodes/relref.md b/docs/content/en/shortcodes/relref.md index 5b413b87e..219eae81a 100755 --- a/docs/content/en/shortcodes/relref.md +++ b/docs/content/en/shortcodes/relref.md @@ -10,7 +10,7 @@ keywords: [] > To override Hugo's embedded `relref` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory. > [!note] -> When working with the Markdown [content format], this shortcode has become largely redundant. Its functionality is now primarily handled by [link render hooks], specifically the embedded one provided by Hugo. This hook effectively addresses all the use cases previously covered by this shortcode. +> When working with Markdown, this shortcode is obsolete. Instead, use a [link render hook] that resolves the link destination using the `GetPage` method on the `Page` object. You can either create your own, or simply enable the [embedded link render hook]. The embedded link render hook is automatically enabled for multilingual single-host projects. ## Usage @@ -56,6 +56,7 @@ Rendered: {{% include "_common/ref-and-relref-error-handling.md" %}} [content format]: /content-management/formats/ -[link render hooks]: /render-hooks/links/ +[embedded link render hook]: /render-hooks/links/#default +[link render hook]: /render-hooks/links/ [Markdown notation]: /content-management/shortcodes/#notation [source code]: {{% eturl relref %}} diff --git a/docs/content/en/shortcodes/vimeo.md b/docs/content/en/shortcodes/vimeo.md index c354eefe0..1164ce997 100755 --- a/docs/content/en/shortcodes/vimeo.md +++ b/docs/content/en/shortcodes/vimeo.md @@ -29,19 +29,27 @@ Hugo renders this to: ## Arguments +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.146.0 />}} +: (`bool`) Whether the `iframe` element can activate full screen mode. Default is `true`. + class : (`string`) The `class` attribute of the wrapping `div` element. Adding one or more CSS classes disables inline styling. -id -: (`string`) The `id` of the Vimeo video +loading +: {{< new-in 0.146.0 />}} +: (`string`) The loading attribute of the `iframe` element, either `eager` or `lazy`. Default is `eager`. title : (`string`) The `title` attribute of the `iframe` element. -If you provide a `class` or `title` you must use a named parameter for the `id`. +Here's an example using some of the available arguments: ```text -{{}} +{{}} ``` ## Privacy diff --git a/docs/content/en/shortcodes/youtube.md b/docs/content/en/shortcodes/youtube.md index 18c5ae6c2..ed3cf0632 100755 --- a/docs/content/en/shortcodes/youtube.md +++ b/docs/content/en/shortcodes/youtube.md @@ -70,7 +70,7 @@ start title : (`string`) The `title` attribute of the `iframe` element. Defaults to "YouTube video". -Example using some of the above: +Here's an example using some of the available arguments: ```text {{}} diff --git a/docs/content/en/templates/embedded.md b/docs/content/en/templates/embedded.md index 198136393..ecfd90514 100644 --- a/docs/content/en/templates/embedded.md +++ b/docs/content/en/templates/embedded.md @@ -1,6 +1,6 @@ --- -title: Embedded templates -description: Hugo provides embedded templates for common use cases. +title: Embedded partial templates +description: Hugo provides embedded partial templates for common use cases. categories: [] keywords: [] weight: 170 @@ -145,6 +145,10 @@ Various optional metadata can also be set: If using YouTube this will produce a og:video tag like ``. Use the `https://youtu.be/` format with YouTube videos (example: `https://youtu.be/qtIqKaDlqXo`). +## Pagination + +See [details](/templates/pagination/). + ## Schema > [!note] diff --git a/docs/content/en/templates/partial.md b/docs/content/en/templates/partial.md index 8493a4674..7ff2d9594 100644 --- a/docs/content/en/templates/partial.md +++ b/docs/content/en/templates/partial.md @@ -49,7 +49,7 @@ As shown in the above example directory structure, you can nest your directories ### Variable scoping -The second argument in a partial call is the variable being passed down. The above examples are passing the `.`, which tells the template receiving the partial to apply the current [context][context]. +The second argument in a partial call is the variable being passed down. The above examples are passing the dot (`.`), which tells the template receiving the partial to apply the current [context][context]. This means the partial will *only* be able to access those variables. The partial is isolated and cannot access the outer scope. From within the partial, `$.Var` is equivalent to `.Var`. diff --git a/docs/content/en/templates/shortcode.md b/docs/content/en/templates/shortcode.md index 711d342cb..3ed573651 100644 --- a/docs/content/en/templates/shortcode.md +++ b/docs/content/en/templates/shortcode.md @@ -329,7 +329,7 @@ You can use the `HasShortcode` method in your base template to conditionally loa [`with`]: /functions/go-template/with/ [content management]: /content-management/shortcodes/ [embedded shortcodes]: /shortcodes/ -[GitHub]: https://github.com/gohugoio/hugo/tree/master/tpl/tplimpl/embedded/templates/shortcodes +[GitHub]: https://github.com/gohugoio/hugo/tree/master/tpl/tplimpl/embedded/templates/_shortcodes [introduction to templating]: /templates/introduction/ [Markdown notation]: /content-management/shortcodes/#markdown-notation [named or positional]: /content-management/shortcodes/#arguments diff --git a/docs/content/en/troubleshooting/inspection.md b/docs/content/en/troubleshooting/inspection.md index dc662243a..ea3c097f9 100644 --- a/docs/content/en/troubleshooting/inspection.md +++ b/docs/content/en/troubleshooting/inspection.md @@ -34,6 +34,11 @@ Use the [`printf`] function (render) or [`warnf`] function (log to console) to i {{ printf "%[1]v (%[1]T)" $value }} → 42 (int) ``` +{{< new-in 0.146.0 />}} + +Use the [`templates.Current`] function to visually mark template execution boundaries or to display the template call stack. + [`debug.Dump`]: /functions/debug/dump/ [`printf`]: /functions/fmt/printf/ [`warnf`]: /functions/fmt/warnf/ +[`templates.Current`]: /functions/templates/current/ diff --git a/docs/data/embedded_template_urls.toml b/docs/data/embedded_template_urls.toml index f75b14f12..b2a796cd1 100644 --- a/docs/data/embedded_template_urls.toml +++ b/docs/data/embedded_template_urls.toml @@ -4,39 +4,39 @@ # BaseURL 'base_url' = 'https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates' -# Templates -'alias' = 'alias.html' -'disqus' = 'disqus.html' -'google_analytics' = 'google_analytics.html' -'opengraph' = 'opengraph.html' -'pagination' = 'pagination.html' -'robots' = '_default/robots.txt' -'rss' = '_default/rss.xml' -'schema' = 'schema.html' -'sitemap' = '_default/sitemap.xml' -'sitemapindex' = '_default/sitemapindex.xml' -'twitter_cards' = 'twitter_cards.html' +# Partials +'disqus' = '_partials/disqus.html' +'google_analytics' = '_partials/google_analytics.html' +'opengraph' = '_partials/opengraph.html' +'pagination' = '_partials/pagination.html' +'schema' = '_partials/schema.html' +'twitter_cards' = '_partials/twitter_cards.html' # Render hooks -'render-codeblock-goat' = '_default/_markup/render-codeblock-goat.html' -'render-image' = '_default/_markup/render-image.html' -'render-link' = '_default/_markup/render-link.html' -'render-table' = '_default/_markup/render-table.html' +'render-codeblock-goat' = '_markup/render-codeblock-goat.html' +'render-image' = '_markup/render-image.html' +'render-link' = '_markup/render-link.html' +'render-table' = '_markup/render-table.html' # Shortcodes -'details' = 'shortcodes/details.html' -'figure' = 'shortcodes/figure.html' -'gist' = 'shortcodes/gist.html' -'highlight' = 'shortcodes/highlight.html' -'instagram' = 'shortcodes/instagram.html' -'param' = 'shortcodes/param.html' -'qr' = 'shortcodes/qr.html' -'ref' = 'shortcodes/ref.html' -'relref' = 'shortcodes/relref.html' -'twitter' = 'shortcodes/twitter.html' -'twitter_simple' = 'shortcodes/twitter_simple.html' -'vimeo' = 'shortcodes/vimeo.html' -'vimeo_simple' = 'shortcodes/vimeo_simple.html' -'x' = 'shortcodes/x.html' -'x_simple' = 'shortcodes/x_simple.html' -'youtube' = 'shortcodes/youtube.html' +'details' = '_shortcodes/details.html' +'figure' = '_shortcodes/figure.html' +'gist' = '_shortcodes/gist.html' +'highlight' = '_shortcodes/highlight.html' +'instagram' = '_shortcodes/instagram.html' +'param' = '_shortcodes/param.html' +'qr' = '_shortcodes/qr.html' +'ref' = '_shortcodes/ref.html' +'relref' = '_shortcodes/relref.html' +'vimeo' = '_shortcodes/vimeo.html' +'vimeo_simple' = '_shortcodes/vimeo_simple.html' +'x' = '_shortcodes/x.html' +'x_simple' = '_shortcodes/x_simple.html' +'youtube' = '_shortcodes/youtube.html' + +# Other +'alias' = 'alias.html' +'robots' = 'robots.txt' +'rss' = 'rss.xml' +'sitemap' = 'sitemap.xml' +'sitemapindex' = 'sitemapindex.xml' diff --git a/docs/layouts/_default/_markup/render-blockquote.html b/docs/layouts/_markup/render-blockquote.html similarity index 100% rename from docs/layouts/_default/_markup/render-blockquote.html rename to docs/layouts/_markup/render-blockquote.html diff --git a/docs/layouts/_default/_markup/render-codeblock.html b/docs/layouts/_markup/render-codeblock.html similarity index 100% rename from docs/layouts/_default/_markup/render-codeblock.html rename to docs/layouts/_markup/render-codeblock.html diff --git a/docs/layouts/_default/_markup/render-link.html b/docs/layouts/_markup/render-link.html similarity index 98% rename from docs/layouts/_default/_markup/render-link.html rename to docs/layouts/_markup/render-link.html index 88e3cbee5..70011220e 100644 --- a/docs/layouts/_default/_markup/render-link.html +++ b/docs/layouts/_markup/render-link.html @@ -196,7 +196,7 @@ either of these shortcodes in conjunction with this render hook. >{{ .Text }} -{{- define "partials/inline/h-rh-l/validate-fragment.html" }} +{{- define "_partials/inline/h-rh-l/validate-fragment.html" }} {{- /* Validates the fragment portion of a link destination. @@ -248,7 +248,7 @@ either of these shortcodes in conjunction with this render hook. {{- end }} {{- end }} -{{- define "partials/inline/h-rh-l/get-glossary-link-attributes.html" }} +{{- define "_partials/inline/h-rh-l/get-glossary-link-attributes.html" }} {{- /* Returns the anchor element attributes for a link to the given glossary term. diff --git a/docs/layouts/_default/_markup/render-passthrough.html b/docs/layouts/_markup/render-passthrough.html similarity index 100% rename from docs/layouts/_default/_markup/render-passthrough.html rename to docs/layouts/_markup/render-passthrough.html diff --git a/docs/layouts/_default/_markup/render-table.html b/docs/layouts/_markup/render-table.html similarity index 100% rename from docs/layouts/_default/_markup/render-table.html rename to docs/layouts/_markup/render-table.html diff --git a/docs/layouts/partials/docs/functions-aliases.html b/docs/layouts/_partials/docs/functions-aliases.html similarity index 100% rename from docs/layouts/partials/docs/functions-aliases.html rename to docs/layouts/_partials/docs/functions-aliases.html diff --git a/docs/layouts/partials/docs/functions-return-type.html b/docs/layouts/_partials/docs/functions-return-type.html similarity index 100% rename from docs/layouts/partials/docs/functions-return-type.html rename to docs/layouts/_partials/docs/functions-return-type.html diff --git a/docs/layouts/partials/docs/functions-signatures.html b/docs/layouts/_partials/docs/functions-signatures.html similarity index 100% rename from docs/layouts/partials/docs/functions-signatures.html rename to docs/layouts/_partials/docs/functions-signatures.html diff --git a/docs/layouts/partials/helpers/debug/list-item-metadata.html b/docs/layouts/_partials/helpers/debug/list-item-metadata.html similarity index 100% rename from docs/layouts/partials/helpers/debug/list-item-metadata.html rename to docs/layouts/_partials/helpers/debug/list-item-metadata.html diff --git a/docs/layouts/partials/helpers/funcs/color-from-string.html b/docs/layouts/_partials/helpers/funcs/color-from-string.html similarity index 100% rename from docs/layouts/partials/helpers/funcs/color-from-string.html rename to docs/layouts/_partials/helpers/funcs/color-from-string.html diff --git a/docs/layouts/partials/helpers/funcs/get-github-info.html b/docs/layouts/_partials/helpers/funcs/get-github-info.html similarity index 100% rename from docs/layouts/partials/helpers/funcs/get-github-info.html rename to docs/layouts/_partials/helpers/funcs/get-github-info.html diff --git a/docs/layouts/partials/helpers/funcs/get-remote-data.html b/docs/layouts/_partials/helpers/funcs/get-remote-data.html similarity index 100% rename from docs/layouts/partials/helpers/funcs/get-remote-data.html rename to docs/layouts/_partials/helpers/funcs/get-remote-data.html diff --git a/docs/layouts/partials/helpers/gtag.html b/docs/layouts/_partials/helpers/gtag.html similarity index 100% rename from docs/layouts/partials/helpers/gtag.html rename to docs/layouts/_partials/helpers/gtag.html diff --git a/docs/layouts/partials/helpers/linkcss.html b/docs/layouts/_partials/helpers/linkcss.html similarity index 100% rename from docs/layouts/partials/helpers/linkcss.html rename to docs/layouts/_partials/helpers/linkcss.html diff --git a/docs/layouts/partials/helpers/linkjs.html b/docs/layouts/_partials/helpers/linkjs.html similarity index 100% rename from docs/layouts/partials/helpers/linkjs.html rename to docs/layouts/_partials/helpers/linkjs.html diff --git a/docs/layouts/partials/helpers/picture.html b/docs/layouts/_partials/helpers/picture.html similarity index 92% rename from docs/layouts/partials/helpers/picture.html rename to docs/layouts/_partials/helpers/picture.html index 454dd705e..4dc16c002 100644 --- a/docs/layouts/partials/helpers/picture.html +++ b/docs/layouts/_partials/helpers/picture.html @@ -5,6 +5,7 @@ {{ $image1x := $image.Resize (printf "%dx" $width1x) }} {{ $image1xWebp := $image.Resize (printf "%dx webp" $width1x) }} {{ $class := .class | default "h-64 tablet:h-96 lg:h-full w-full object-cover lg:absolute" }} +{{ $loading := .loading | default "eager" }} diff --git a/docs/layouts/partials/helpers/validation/validate-keywords.html b/docs/layouts/_partials/helpers/validation/validate-keywords.html similarity index 100% rename from docs/layouts/partials/helpers/validation/validate-keywords.html rename to docs/layouts/_partials/helpers/validation/validate-keywords.html diff --git a/docs/layouts/partials/layouts/blocks/alert.html b/docs/layouts/_partials/layouts/blocks/alert.html similarity index 100% rename from docs/layouts/partials/layouts/blocks/alert.html rename to docs/layouts/_partials/layouts/blocks/alert.html diff --git a/docs/layouts/partials/layouts/blocks/modal.html b/docs/layouts/_partials/layouts/blocks/modal.html similarity index 100% rename from docs/layouts/partials/layouts/blocks/modal.html rename to docs/layouts/_partials/layouts/blocks/modal.html diff --git a/docs/layouts/partials/layouts/breadcrumbs.html b/docs/layouts/_partials/layouts/breadcrumbs.html similarity index 100% rename from docs/layouts/partials/layouts/breadcrumbs.html rename to docs/layouts/_partials/layouts/breadcrumbs.html diff --git a/docs/layouts/partials/layouts/date.html b/docs/layouts/_partials/layouts/date.html similarity index 100% rename from docs/layouts/partials/layouts/date.html rename to docs/layouts/_partials/layouts/date.html diff --git a/docs/layouts/partials/layouts/docsheader.html b/docs/layouts/_partials/layouts/docsheader.html similarity index 100% rename from docs/layouts/partials/layouts/docsheader.html rename to docs/layouts/_partials/layouts/docsheader.html diff --git a/docs/layouts/partials/layouts/explorer.html b/docs/layouts/_partials/layouts/explorer.html similarity index 100% rename from docs/layouts/partials/layouts/explorer.html rename to docs/layouts/_partials/layouts/explorer.html diff --git a/docs/layouts/partials/layouts/footer.html b/docs/layouts/_partials/layouts/footer.html similarity index 100% rename from docs/layouts/partials/layouts/footer.html rename to docs/layouts/_partials/layouts/footer.html diff --git a/docs/layouts/partials/layouts/head/head-js.html b/docs/layouts/_partials/layouts/head/head-js.html similarity index 100% rename from docs/layouts/partials/layouts/head/head-js.html rename to docs/layouts/_partials/layouts/head/head-js.html diff --git a/docs/layouts/partials/layouts/head/head.html b/docs/layouts/_partials/layouts/head/head.html similarity index 100% rename from docs/layouts/partials/layouts/head/head.html rename to docs/layouts/_partials/layouts/head/head.html diff --git a/docs/layouts/partials/layouts/header/githubstars.html b/docs/layouts/_partials/layouts/header/githubstars.html similarity index 100% rename from docs/layouts/partials/layouts/header/githubstars.html rename to docs/layouts/_partials/layouts/header/githubstars.html diff --git a/docs/layouts/partials/layouts/header/header.html b/docs/layouts/_partials/layouts/header/header.html similarity index 100% rename from docs/layouts/partials/layouts/header/header.html rename to docs/layouts/_partials/layouts/header/header.html diff --git a/docs/layouts/partials/layouts/header/qr.html b/docs/layouts/_partials/layouts/header/qr.html similarity index 96% rename from docs/layouts/partials/layouts/header/qr.html rename to docs/layouts/_partials/layouts/header/qr.html index ccc0ee959..fea64f625 100644 --- a/docs/layouts/partials/layouts/header/qr.html +++ b/docs/layouts/_partials/layouts/header/qr.html @@ -10,7 +10,7 @@ {{ partial "layouts/blocks/modal.html" (dict "modal_button" $qr "modal_content" $qrBig "modal_title" (printf "QR code linking to %s" $.Permalink )) }} -{{ define "partials/_inline/qr" }} +{{ define "_partials/_inline/qr" }} {{ $img_class := .img_class | default "w-10" }} {{ with images.QR $.page.Permalink (dict "targetDir" "images/qr") }} diff --git a/docs/layouts/partials/layouts/header/theme.html b/docs/layouts/_partials/layouts/header/theme.html similarity index 100% rename from docs/layouts/partials/layouts/header/theme.html rename to docs/layouts/_partials/layouts/header/theme.html diff --git a/docs/layouts/partials/layouts/home/features.html b/docs/layouts/_partials/layouts/home/features.html similarity index 100% rename from docs/layouts/partials/layouts/home/features.html rename to docs/layouts/_partials/layouts/home/features.html diff --git a/docs/layouts/partials/layouts/home/opensource.html b/docs/layouts/_partials/layouts/home/opensource.html similarity index 100% rename from docs/layouts/partials/layouts/home/opensource.html rename to docs/layouts/_partials/layouts/home/opensource.html diff --git a/docs/layouts/partials/layouts/home/sponsors.html b/docs/layouts/_partials/layouts/home/sponsors.html similarity index 100% rename from docs/layouts/partials/layouts/home/sponsors.html rename to docs/layouts/_partials/layouts/home/sponsors.html diff --git a/docs/layouts/partials/layouts/hooks/body-end.html b/docs/layouts/_partials/layouts/hooks/body-end.html similarity index 100% rename from docs/layouts/partials/layouts/hooks/body-end.html rename to docs/layouts/_partials/layouts/hooks/body-end.html diff --git a/docs/layouts/partials/layouts/hooks/body-main-start.html b/docs/layouts/_partials/layouts/hooks/body-main-start.html similarity index 100% rename from docs/layouts/partials/layouts/hooks/body-main-start.html rename to docs/layouts/_partials/layouts/hooks/body-main-start.html diff --git a/docs/layouts/partials/layouts/hooks/body-start.html b/docs/layouts/_partials/layouts/hooks/body-start.html similarity index 100% rename from docs/layouts/partials/layouts/hooks/body-start.html rename to docs/layouts/_partials/layouts/hooks/body-start.html diff --git a/docs/layouts/partials/layouts/icons.html b/docs/layouts/_partials/layouts/icons.html similarity index 100% rename from docs/layouts/partials/layouts/icons.html rename to docs/layouts/_partials/layouts/icons.html diff --git a/docs/layouts/partials/layouts/in-this-section.html b/docs/layouts/_partials/layouts/in-this-section.html similarity index 100% rename from docs/layouts/partials/layouts/in-this-section.html rename to docs/layouts/_partials/layouts/in-this-section.html diff --git a/docs/layouts/partials/layouts/page-edit.html b/docs/layouts/_partials/layouts/page-edit.html similarity index 100% rename from docs/layouts/partials/layouts/page-edit.html rename to docs/layouts/_partials/layouts/page-edit.html diff --git a/docs/layouts/partials/layouts/related.html b/docs/layouts/_partials/layouts/related.html similarity index 100% rename from docs/layouts/partials/layouts/related.html rename to docs/layouts/_partials/layouts/related.html diff --git a/docs/layouts/partials/layouts/search/algolialogo.html b/docs/layouts/_partials/layouts/search/algolialogo.html similarity index 100% rename from docs/layouts/partials/layouts/search/algolialogo.html rename to docs/layouts/_partials/layouts/search/algolialogo.html diff --git a/docs/layouts/partials/layouts/search/button.html b/docs/layouts/_partials/layouts/search/button.html similarity index 100% rename from docs/layouts/partials/layouts/search/button.html rename to docs/layouts/_partials/layouts/search/button.html diff --git a/docs/layouts/partials/layouts/search/input.html b/docs/layouts/_partials/layouts/search/input.html similarity index 100% rename from docs/layouts/partials/layouts/search/input.html rename to docs/layouts/_partials/layouts/search/input.html diff --git a/docs/layouts/partials/layouts/search/results.html b/docs/layouts/_partials/layouts/search/results.html similarity index 100% rename from docs/layouts/partials/layouts/search/results.html rename to docs/layouts/_partials/layouts/search/results.html diff --git a/docs/layouts/partials/layouts/templates.html b/docs/layouts/_partials/layouts/templates.html similarity index 100% rename from docs/layouts/partials/layouts/templates.html rename to docs/layouts/_partials/layouts/templates.html diff --git a/docs/layouts/partials/layouts/toc.html b/docs/layouts/_partials/layouts/toc.html similarity index 100% rename from docs/layouts/partials/layouts/toc.html rename to docs/layouts/_partials/layouts/toc.html diff --git a/docs/layouts/partials/opengraph/get-featured-image.html b/docs/layouts/_partials/opengraph/get-featured-image.html similarity index 100% rename from docs/layouts/partials/opengraph/get-featured-image.html rename to docs/layouts/_partials/opengraph/get-featured-image.html diff --git a/docs/layouts/partials/opengraph/opengraph.html b/docs/layouts/_partials/opengraph/opengraph.html similarity index 100% rename from docs/layouts/partials/opengraph/opengraph.html rename to docs/layouts/_partials/opengraph/opengraph.html diff --git a/docs/layouts/shortcodes/chroma-lexers.html b/docs/layouts/_shortcodes/chroma-lexers.html similarity index 100% rename from docs/layouts/shortcodes/chroma-lexers.html rename to docs/layouts/_shortcodes/chroma-lexers.html diff --git a/docs/layouts/shortcodes/code-toggle.html b/docs/layouts/_shortcodes/code-toggle.html similarity index 100% rename from docs/layouts/shortcodes/code-toggle.html rename to docs/layouts/_shortcodes/code-toggle.html diff --git a/docs/layouts/shortcodes/datatable-filtered.html b/docs/layouts/_shortcodes/datatable-filtered.html similarity index 100% rename from docs/layouts/shortcodes/datatable-filtered.html rename to docs/layouts/_shortcodes/datatable-filtered.html diff --git a/docs/layouts/shortcodes/datatable.html b/docs/layouts/_shortcodes/datatable.html similarity index 100% rename from docs/layouts/shortcodes/datatable.html rename to docs/layouts/_shortcodes/datatable.html diff --git a/docs/layouts/shortcodes/deprecated-in.html b/docs/layouts/_shortcodes/deprecated-in.html similarity index 100% rename from docs/layouts/shortcodes/deprecated-in.html rename to docs/layouts/_shortcodes/deprecated-in.html diff --git a/docs/layouts/shortcodes/eturl.html b/docs/layouts/_shortcodes/eturl.html similarity index 100% rename from docs/layouts/shortcodes/eturl.html rename to docs/layouts/_shortcodes/eturl.html diff --git a/docs/layouts/shortcodes/glossary-term.html b/docs/layouts/_shortcodes/glossary-term.html similarity index 100% rename from docs/layouts/shortcodes/glossary-term.html rename to docs/layouts/_shortcodes/glossary-term.html diff --git a/docs/layouts/shortcodes/glossary.html b/docs/layouts/_shortcodes/glossary.html similarity index 100% rename from docs/layouts/shortcodes/glossary.html rename to docs/layouts/_shortcodes/glossary.html diff --git a/docs/layouts/shortcodes/hl.html b/docs/layouts/_shortcodes/hl.html similarity index 100% rename from docs/layouts/shortcodes/hl.html rename to docs/layouts/_shortcodes/hl.html diff --git a/docs/layouts/shortcodes/img.html b/docs/layouts/_shortcodes/img.html similarity index 99% rename from docs/layouts/shortcodes/img.html rename to docs/layouts/_shortcodes/img.html index 60187802e..e49afc57f 100644 --- a/docs/layouts/shortcodes/img.html +++ b/docs/layouts/_shortcodes/img.html @@ -359,7 +359,7 @@ When using the padding filter, provide all arguments in this order: {{- end }} {{- end }} -{{- define "partials/inline/get-resource.html" }} +{{- define "_partials/inline/get-resource.html" }} {{- $r := "" }} {{- $u := urls.Parse .src }} {{- $msg := "The %q shortcode was unable to resolve %s. See %s" }} diff --git a/docs/layouts/shortcodes/imgproc.html b/docs/layouts/_shortcodes/imgproc.html similarity index 100% rename from docs/layouts/shortcodes/imgproc.html rename to docs/layouts/_shortcodes/imgproc.html diff --git a/docs/layouts/shortcodes/include.html b/docs/layouts/_shortcodes/include.html similarity index 100% rename from docs/layouts/shortcodes/include.html rename to docs/layouts/_shortcodes/include.html diff --git a/docs/layouts/shortcodes/list-pages-in-section.html b/docs/layouts/_shortcodes/list-pages-in-section.html similarity index 100% rename from docs/layouts/shortcodes/list-pages-in-section.html rename to docs/layouts/_shortcodes/list-pages-in-section.html diff --git a/docs/layouts/shortcodes/module-mounts-note.html b/docs/layouts/_shortcodes/module-mounts-note.html similarity index 100% rename from docs/layouts/shortcodes/module-mounts-note.html rename to docs/layouts/_shortcodes/module-mounts-note.html diff --git a/docs/layouts/shortcodes/new-in.html b/docs/layouts/_shortcodes/new-in.html similarity index 100% rename from docs/layouts/shortcodes/new-in.html rename to docs/layouts/_shortcodes/new-in.html diff --git a/docs/layouts/shortcodes/per-lang-config-keys.html b/docs/layouts/_shortcodes/per-lang-config-keys.html similarity index 97% rename from docs/layouts/shortcodes/per-lang-config-keys.html rename to docs/layouts/_shortcodes/per-lang-config-keys.html index f6090d555..31d7daf6a 100644 --- a/docs/layouts/shortcodes/per-lang-config-keys.html +++ b/docs/layouts/_shortcodes/per-lang-config-keys.html @@ -14,8 +14,8 @@ separately for each language. (dict "contentDir" "/configuration/all/#contentdir") (dict "copyright" "/configuration/all/#copyright") (dict "disableAliases" "/configuration/all/#disablealiases") - (dict "disableHugoGeneratorInject" "/configuration/all/#disableHugogeneratorinject") - (dict "disableKinds" "/configuration/all/#disableKinds") + (dict "disableHugoGeneratorInject" "/configuration/all/#disablehugogeneratorinject") + (dict "disableKinds" "/configuration/all/#disablekinds") (dict "disableLiveReload" "/configuration/all/#disablelivereload") (dict "disablePathToLower" "/configuration/all/#disablepathtolower") (dict "enableEmoji " "/configuration/all/#enableemoji") diff --git a/docs/layouts/shortcodes/quick-reference.html b/docs/layouts/_shortcodes/quick-reference.html similarity index 100% rename from docs/layouts/shortcodes/quick-reference.html rename to docs/layouts/_shortcodes/quick-reference.html diff --git a/docs/layouts/shortcodes/root-configuration-keys.html b/docs/layouts/_shortcodes/root-configuration-keys.html similarity index 100% rename from docs/layouts/shortcodes/root-configuration-keys.html rename to docs/layouts/_shortcodes/root-configuration-keys.html diff --git a/docs/layouts/shortcodes/syntax-highlighting-styles.html b/docs/layouts/_shortcodes/syntax-highlighting-styles.html similarity index 100% rename from docs/layouts/shortcodes/syntax-highlighting-styles.html rename to docs/layouts/_shortcodes/syntax-highlighting-styles.html diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/baseof.html similarity index 98% rename from docs/layouts/_default/baseof.html rename to docs/layouts/baseof.html index 1f4952146..4c14a6b6d 100644 --- a/docs/layouts/_default/baseof.html +++ b/docs/layouts/baseof.html @@ -44,6 +44,8 @@ {{ block "header" . }} {{ partial "layouts/header/header.html" . }} {{ end }} + {{ block "subheader" . }} + {{ end }} {{ block "hero" . }} {{ end }}
diff --git a/docs/layouts/index.headers b/docs/layouts/home.headers similarity index 100% rename from docs/layouts/index.headers rename to docs/layouts/home.headers diff --git a/docs/layouts/index.html b/docs/layouts/home.html similarity index 100% rename from docs/layouts/index.html rename to docs/layouts/home.html diff --git a/docs/layouts/index.redir b/docs/layouts/home.redir similarity index 100% rename from docs/layouts/index.redir rename to docs/layouts/home.redir diff --git a/docs/layouts/_default/list.html b/docs/layouts/list.html similarity index 100% rename from docs/layouts/_default/list.html rename to docs/layouts/list.html diff --git a/docs/layouts/_default/list.rss.xml b/docs/layouts/list.rss.xml similarity index 100% rename from docs/layouts/_default/list.rss.xml rename to docs/layouts/list.rss.xml diff --git a/docs/layouts/_default/single.html b/docs/layouts/single.html similarity index 100% rename from docs/layouts/_default/single.html rename to docs/layouts/single.html diff --git a/docs/netlify.toml b/docs/netlify.toml index 67c146cad..c24a32a60 100644 --- a/docs/netlify.toml +++ b/docs/netlify.toml @@ -3,7 +3,7 @@ command = "hugo --gc --minify" [build.environment] - HUGO_VERSION = "0.145.0" + HUGO_VERSION = "0.146.7" [context.production.environment] HUGO_ENV = "production" diff --git a/docs/package.hugo.json b/docs/package.hugo.json new file mode 100644 index 000000000..24ffc7ff5 --- /dev/null +++ b/docs/package.hugo.json @@ -0,0 +1,25 @@ +{ + "name": "hugoDocs", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "", + "devDependencies": { + "@awmottaz/prettier-plugin-void-html": "~1.8.0", + "@tailwindcss/cli": "~4.1.0", + "@tailwindcss/typography": "~0.5.16", + "prettier": "~3.5.3", + "prettier-plugin-go-template": "~0.0.15", + "tailwindcss": "~4.1.0" + }, + "dependencies": { + "@alpinejs/focus": "~3.14.9", + "@alpinejs/persist": "~3.14.9", + "@hotwired/turbo": "~8.0.13", + "alpinejs": "~3.14.9" + } +}