Squashed 'docs/' changes from dc7a9ae12..b654fcba0 - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit b3d87dd0fd746f07f9afa6e6a2969aea41da6a38
DIR parent 5be51ac3db225d5df501ed1fa1499c41d97dbf65
HTML Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Thu, 24 Apr 2025 10:23:16 +0200
Squashed 'docs/' changes from dc7a9ae12..b654fcba0
b654fcba0 content: Fix links
d44357418 content: Update GitLab Pages workflow example
33968c7e2 content: Update Netlify configuration file
a6d0c8c50 content: Update GitHub Pages workflow example
d1aabfa36 content: Fix broken link
7b50139a6 content: Miscellaneous edits
a30e2c189 Menus: add forgotten link target
5c2aa88b4 content: Updates for v0.146.7
114413c18 netlify: Hugo 0.146.7
67e9261b1 netlify: Hugo 0.146.6
efa040229 content: Update templates/embedded.md
b8f888c76 theme: Rename internal templates from partials/ to _partials/
727178cbb content: Fix broken anchor links
0f12708f1 Fix typo
380b1c163 Update Current.md
8b500f3e5 netlify: Hugo 0.146.5
e3d6b6fad netlify: Hugo 0.146.4
ac1b92713 content: Fix text formatting in templates/partial.md
719329530 content: Clarify usage of template function
a95eca524 theme: Misc adjustments for the themes site
8e6c26067 Add package.hugo.json
9691007fb netlify: Hugo 0.146.3
ec08acc59 netlify: Hugo 0.146.2
8f320a0b6 netlify: Hugo 0.146.1
d5e6cb618 content: Remove expired new-in badges
b5779d7fc content: Update templates.Current function
5df1229d5 theme: Move templates to new structure
a7a6a614d theme: Remove accidentally added template
195b368e8 content: Miscellaneous updates related to v0.146.0
0a906ad49 netlify: Hugo 0.146.0
git-subtree-dir: docs
git-subtree-split: b654fcba0d4385da1e47179ef3763f277f044242
Diffstat:
M content/en/configuration/introduct… | 2 +-
M content/en/content-management/menu… | 2 +-
M content/en/contribute/documentatio… | 2 +-
M content/en/functions/collections/W… | 3 ---
M content/en/functions/css/Sass.md | 140 ++++++++++++-------------------
M content/en/functions/go-template/t… | 28 ++++++++++++++++++++++++++--
A content/en/functions/templates/Cur… | 155 +++++++++++++++++++++++++++++++
A content/en/functions/time/In.md | 30 ++++++++++++++++++++++++++++++
M content/en/functions/transform/Unm… | 85 +++++++++++++++++++++++++++++--
M content/en/host-and-deploy/host-on… | 2 ++
M content/en/host-and-deploy/host-on… | 10 ++++++----
M content/en/host-and-deploy/host-on… | 11 +++++++----
M content/en/installation/linux.md | 20 ++++++++++++++++++--
M content/en/news/_content.gotmpl | 3 ++-
A content/en/quick-reference/glossar… | 6 ++++++
A content/en/quick-reference/glossar… | 6 ++++++
M content/en/shortcodes/ref.md | 7 ++++---
M content/en/shortcodes/relref.md | 5 +++--
M content/en/shortcodes/vimeo.md | 16 ++++++++++++----
M content/en/shortcodes/youtube.md | 2 +-
M content/en/templates/embedded.md | 8 ++++++--
M content/en/templates/partial.md | 2 +-
M content/en/templates/shortcode.md | 2 +-
M content/en/troubleshooting/inspect… | 5 +++++
M data/embedded_template_urls.toml | 64 ++++++++++++++++----------------
D layouts/_default/_markup/render-li… | 320 -------------------------------
D layouts/_default/baseof.html | 72 -------------------------------
R layouts/_default/_markup/render-bl… | 0
R layouts/_default/_markup/render-co… | 0
A layouts/_markup/render-link.html | 320 +++++++++++++++++++++++++++++++
R layouts/_default/_markup/render-pa… | 0
R layouts/_default/_markup/render-ta… | 0
R layouts/partials/docs/functions-al… | 0
R layouts/partials/docs/functions-re… | 0
R layouts/partials/docs/functions-si… | 0
R layouts/partials/helpers/debug/lis… | 0
R layouts/partials/helpers/funcs/col… | 0
R layouts/partials/helpers/funcs/get… | 0
R layouts/partials/helpers/funcs/get… | 0
R layouts/partials/helpers/gtag.html… | 0
R layouts/partials/helpers/linkcss.h… | 0
R layouts/partials/helpers/linkjs.ht… | 0
A layouts/_partials/helpers/picture.… | 27 +++++++++++++++++++++++++++
R layouts/partials/helpers/validatio… | 0
R layouts/partials/layouts/blocks/al… | 0
R layouts/partials/layouts/blocks/mo… | 0
R layouts/partials/layouts/breadcrum… | 0
R layouts/partials/layouts/date.html… | 0
R layouts/partials/layouts/docsheade… | 0
R layouts/partials/layouts/explorer.… | 0
R layouts/partials/layouts/footer.ht… | 0
R layouts/partials/layouts/head/head… | 0
R layouts/partials/layouts/head/head… | 0
R layouts/partials/layouts/header/gi… | 0
R layouts/partials/layouts/header/he… | 0
A layouts/_partials/layouts/header/q… | 25 +++++++++++++++++++++++++
R layouts/partials/layouts/header/th… | 0
R layouts/partials/layouts/home/feat… | 0
R layouts/partials/layouts/home/open… | 0
R layouts/partials/layouts/home/spon… | 0
R layouts/partials/layouts/hooks/bod… | 0
R layouts/partials/layouts/hooks/bod… | 0
R layouts/partials/layouts/hooks/bod… | 0
R layouts/partials/layouts/icons.htm… | 0
R layouts/partials/layouts/in-this-s… | 0
R layouts/partials/layouts/page-edit… | 0
R layouts/partials/layouts/related.h… | 0
R layouts/partials/layouts/search/al… | 0
R layouts/partials/layouts/search/bu… | 0
R layouts/partials/layouts/search/in… | 0
R layouts/partials/layouts/search/re… | 0
R layouts/partials/layouts/templates… | 0
R layouts/partials/layouts/toc.html … | 0
R layouts/partials/opengraph/get-fea… | 0
R layouts/partials/opengraph/opengra… | 0
R layouts/shortcodes/chroma-lexers.h… | 0
R layouts/shortcodes/code-toggle.htm… | 0
R layouts/shortcodes/datatable-filte… | 0
R layouts/shortcodes/datatable.html … | 0
R layouts/shortcodes/deprecated-in.h… | 0
R layouts/shortcodes/eturl.html -> l… | 0
R layouts/shortcodes/glossary-term.h… | 0
R layouts/shortcodes/glossary.html -… | 0
R layouts/shortcodes/hl.html -> layo… | 0
A layouts/_shortcodes/img.html | 391 ++++++++++++++++++++++++++++++
R layouts/shortcodes/imgproc.html ->… | 0
R layouts/shortcodes/include.html ->… | 0
R layouts/shortcodes/list-pages-in-s… | 0
R layouts/shortcodes/module-mounts-n… | 0
R layouts/shortcodes/new-in.html -> … | 0
A layouts/_shortcodes/per-lang-confi… | 71 +++++++++++++++++++++++++++++++
R layouts/shortcodes/quick-reference… | 0
R layouts/shortcodes/root-configurat… | 0
R layouts/shortcodes/syntax-highligh… | 0
A layouts/baseof.html | 74 +++++++++++++++++++++++++++++++
R layouts/index.headers -> layouts/h… | 0
R layouts/index.html -> layouts/home… | 0
R layouts/index.redir -> layouts/hom… | 0
R layouts/_default/list.html -> layo… | 0
R layouts/_default/list.rss.xml -> l… | 0
D layouts/partials/helpers/picture.h… | 25 -------------------------
D layouts/partials/layouts/header/qr… | 25 -------------------------
D layouts/shortcodes/img.html | 391 ------------------------------
D layouts/shortcodes/per-lang-config… | 71 -------------------------------
R layouts/_default/single.html -> la… | 0
M netlify.toml | 2 +-
A package.hugo.json | 25 +++++++++++++++++++++++++
107 files changed, 1397 insertions(+), 1058 deletions(-)
---
DIR diff --git a/content/en/configuration/introduction.md b/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.
DIR diff --git a/content/en/content-management/menus.md b/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.
DIR diff --git a/content/en/contribute/documentation.md b/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
DIR diff --git a/content/en/functions/collections/Where.md b/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
DIR diff --git a/content/en/functions/css/Sass.md b/content/en/functions/css/Sass.md
@@ -12,26 +12,6 @@ params:
{{< new-in 0.128.0 />}}
-```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" "libsass"
- }}
- {{ with . | toCSS $opts }}
- {{ if hugo.IsProduction }}
- {{ with . | fingerprint }}
- <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
- {{ end }}
- {{ else }}
- <link rel="stylesheet" href="{{ .RelPermalink }}">
- {{ end }}
- {{ end }}
-{{ 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.
@@ -41,54 +21,70 @@ Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.
## 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";
+enableSourceMap
+: (`bool`) Whether to generate a source map. Default is `false`.
-// Dart Sass
-@use "hugo:vars" as v;
-```
+includePaths
+: (`slice`) A slice of paths, relative to the project root, that the transpiler will use when resolving `@use` and `@import` statements.
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`.
+: (`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`) Precision of floating point math. Not applicable to Dart Sass.
+: (`int`) The precision of floating point math. Applicable to LibSass. Default is `8`.
-enableSourceMap
-: (`bool`) Whether to generate a source map. Default is `false`.
+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. Not applicable to LibSass. Default is `false`.
+: (`bool`) Whether to embed sources in the generated source map. Applicable to Dart Sass. 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.
+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;
+ ```
-```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 }}
- <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
+## 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" "dartsass"
+ "vars" site.Params.styles
+ "includePaths" (slice "node_modules/bootstrap/scss")
+ }}
+ {{ with . | toCSS $opts }}
+ {{ if hugo.IsProduction }}
+ {{ with . | fingerprint }}
+ <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
+ {{ end }}
+ {{ else }}
+ <link rel="stylesheet" href="{{ .RelPermalink }}">
+ {{ end }}
+ {{ end }}
{{ 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 }}
- <link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
- {{ end }}
- {{ else }}
- <link rel="stylesheet" href="{{ .RelPermalink }}">
- {{ 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
DIR diff --git a/content/en/functions/go-template/template.md b/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/
DIR diff --git a/content/en/functions/templates/Current.md b/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 }}
+ <div class="debug">[entering {{ templates.Current.Filename }}]</div>
+ {{ end }}
+
+ <h1>{{ .Title }}</h1>
+ {{ .Content }}
+
+ {{ if site.Params.debug }}
+ <div class="debug">[leaving {{ templates.Current.Filename }}]</div>
+ {{ 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 }}
+ <div class="debug">
+ {{ range .Ancestors }}
+ {{ .Filename }}<br>
+ {{ with .Base }}
+ {{ .Filename }}<br>
+ {{ end }}
+ {{ end }}
+ </div>
+{{ 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 }}
+ <div class="debug">
+ {{ range .Ancestors.Reverse }}
+ {{ with .Base }}
+ {{ .Filename }}<br>
+ {{ end }}
+ {{ .Filename }}<br>
+ {{ end }}
+ </div>
+{{ 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 }}
+ <div class="debug">
+ <a href="vscode://file/{{ .Filename }}">{{ .Name }}</a>
+ {{ with .Base }}
+ <a href="vscode://file/{{ .Filename }}">{{ .Name }}</a>
+ {{ end }}
+ </div>
+{{ end }}
+```
+
+Then call the partial from any template:
+
+```go-html-template {file="layouts/_default/single.html" copy=true}
+{{ define "main" }}
+ <h1>{{ .Title }}</h1>
+ {{ .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 }}
+ <div class="debug">
+ {{ range .Ancestors }}
+ <a href="vscode://file/{{ .Filename }}">{{ .Filename }}</a><br>
+ {{ with .Base }}
+ <a href="vscode://file/{{ .Filename }}">{{ .Filename }}</a><br>
+ {{ end }}
+ {{ end }}
+ </div>
+{{ end }}
+```
DIR diff --git a/content/en/functions/time/In.md b/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
+```
DIR diff --git a/content/en/functions/transform/Unmarshal.md b/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 }}
+ <table>
+ <thead>
+ <tr>
+ {{ range index . 0 }}
+ <th>{{ . }}</th>
+ {{ end }}
+ </tr>
+ </thead>
+ <tbody>
+ {{ range . | after 1 }}
+ <tr>
+ {{ range . }}
+ <td>{{ . }}</td>
+ {{ end }}
+ </tr>
+ {{ end }}
+ </tbody>
+ </table>
+{{ 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" }}
+ <table>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>breed</th>
+ <th>age</th>
+ </tr>
+ </thead>
+ <tbody>
+ {{ range . }}
+ <tr>
+ <td>{{ .name }}</td>
+ <td>{{ .type }}</td>
+ <td>{{ .breed }}</td>
+ <td>{{ .age }}</td>
+ </tr>
+ {{ end }}
+ </tbody>
+ </table>
+{{ end }}
```
## Working with XML
DIR diff --git a/content/en/host-and-deploy/host-on-github-pages/index.md b/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 \
DIR diff --git a/content/en/host-and-deploy/host-on-gitlab-pages.md b/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
DIR diff --git a/content/en/host-and-deploy/host-on-netlify/index.md b/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 \
"""
```
DIR diff --git a/content/en/installation/linux.md b/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
```
DIR diff --git a/content/en/news/_content.gotmpl b/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 }}
DIR diff --git a/content/en/quick-reference/glossary/iana.md b/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.
DIR diff --git a/content/en/quick-reference/glossary/utc.md b/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.
DIR diff --git a/content/en/shortcodes/ref.md b/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 %}}
DIR diff --git a/content/en/shortcodes/relref.md b/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 %}}
DIR diff --git a/content/en/shortcodes/vimeo.md b/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
-{{</* vimeo id=55073825 class="foo bar" title="My Video" */>}}
+{{</* vimeo id=55073825 allowFullScreen=false loading=lazy */>}}
```
## Privacy
DIR diff --git a/content/en/shortcodes/youtube.md b/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
{{</* youtube id=0RKpf3rK57I start=30 end=60 loading=lazy */>}}
DIR diff --git a/content/en/templates/embedded.md b/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 `<meta property="og:video" content="url">`. Use the `https://youtu.be/<id>` format with YouTube videos (example: `https://youtu.be/qtIqKaDlqXo`).
+## Pagination
+
+See [details](/templates/pagination/).
+
## Schema
> [!note]
DIR diff --git a/content/en/templates/partial.md b/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`.
DIR diff --git a/content/en/templates/shortcode.md b/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
DIR diff --git a/content/en/troubleshooting/inspection.md b/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/
DIR diff --git a/data/embedded_template_urls.toml b/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'
DIR diff --git a/layouts/_default/_markup/render-link.html b/layouts/_default/_markup/render-link.html
@@ -1,320 +0,0 @@
-{{/* prettier-ignore-start */ -}}
-{{- /* Last modified: 2025-01-19T14:44:56-08:00 */}}
-
-{{- /*
-Copyright 2025 Veriphor LLC
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not
-use this file except in compliance with the License. You may obtain a copy of
-the License at
-
-https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-License for the specific language governing permissions and limitations under
-the License.
-*/}}
-
-{{- /*
-This render hook resolves internal destinations by looking for a matching:
-
- 1. Content page
- 2. Page resource (a file in the current page bundle)
- 3. Section resource (a file in the current section)
- 4. Global resource (a file in the assets directory)
-
-It skips the section resource lookup if the current page is a leaf bundle.
-
-External destinations are not modified.
-
-You must place global resources in the assets directory. If you have placed
-your resources in the static directory, and you are unable or unwilling to move
-them, you must mount the static directory to the assets directory by including
-both of these entries in your site configuration:
-
- [[module.mounts]]
- source = 'assets'
- target = 'assets'
-
- [[module.mounts]]
- source = 'static'
- target = 'assets'
-
-By default, if this render hook is unable to resolve a destination, including a
-fragment if present, it passes the destination through without modification. To
-emit a warning or error, set the error level in your site configuration:
-
- [params.render_hooks.link]
- errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
-
-When you set the error level to warning, and you are in a development
-environment, you can visually highlight broken internal links:
-
- [params.render_hooks.link]
- errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
- highlightBroken = true # true or false (default)
-
-This will add a "broken" class to anchor elements with invalid src attributes.
-Add a rule to your CSS targeting the broken links:
-
- a.broken {
- background: #ff0;
- border: 2px solid #f00;
- padding: 0.1em 0.2em;
- }
-
-This render hook may be unable to resolve destinations created with the ref and
-relref shortcodes. Unless you set the error level to ignore you should not use
-either of these shortcodes in conjunction with this render hook.
-
-@context {string} Destination The link destination.
-@context {page} Page A reference to the page containing the link.
-@context {string} PlainText The link description as plain text.
-@context {string} Text The link description.
-@context {string} Title The link title.
-
-@returns {template.html}
-*/ -}}
-{{/* prettier-ignore-end */ -}}
-{{- /* Initialize. */}}
-{{- $renderHookName := "link" }}
-
-{{- /* Verify minimum required version. */}}
-{{- $minHugoVersion := "0.141.0" }}
-{{- if lt hugo.Version $minHugoVersion }}
- {{- errorf "The %q render hook requires Hugo v%s or later." $renderHookName $minHugoVersion }}
-{{- end }}
-
-{{- /* Error level when unable to resolve destination: ignore, warning, or error. */}}
-{{- $errorLevel := or site.Params.render_hooks.link.errorLevel "ignore" | lower }}
-
-{{- /* If true, adds "broken" class to broken links. Applicable in development environment when errorLevel is warning. */}}
-{{- $highlightBrokenLinks := or site.Params.render_hooks.link.highlightBroken false }}
-
-{{- /* Validate error level. */}}
-{{- if not (in (slice "ignore" "warning" "error") $errorLevel) }}
- {{- errorf "The %q render hook is misconfigured. The errorLevel %q is invalid. Please check your site configuration." $renderHookName $errorLevel }}
-{{- end }}
-
-{{- /* Determine content path for warning and error messages. */}}
-{{- $contentPath := .Page.String }}
-
-{{- /* Parse destination. */}}
-{{- $u := urls.Parse .Destination }}
-
-{{- /* Set common message. */}}
-{{- $msg := printf "The %q render hook was unable to resolve the destination %q in %s" $renderHookName $u.String $contentPath }}
-
-{{- /* Set attributes for anchor element. */}}
-{{- $attrs := dict "href" $u.String }}
-{{- if eq $u.String "g" }}
- {{- /* Destination is a glossary term. */}}
- {{- $ctx := dict
- "contentPath" $contentPath
- "errorLevel" $errorLevel
- "renderHookName" $renderHookName
- "text" .Text
- }}
- {{- $attrs = partial "inline/h-rh-l/get-glossary-link-attributes.html" $ctx }}
-{{- else if $u.IsAbs }}
- {{- /* Destination is a remote resource. */}}
- {{- $attrs = merge $attrs (dict "rel" "external") }}
-{{- else }}
- {{- with $u.Path }}
- {{- with $p := or ($.PageInner.GetPage .) ($.PageInner.GetPage (strings.TrimRight "/" .)) }}
- {{- /* Destination is a page. */}}
- {{- $href := .RelPermalink }}
- {{- with $u.RawQuery }}
- {{- $href = printf "%s?%s" $href . }}
- {{- end }}
- {{- with $u.Fragment }}
- {{- $ctx := dict
- "contentPath" $contentPath
- "errorLevel" $errorLevel
- "page" $p
- "parsedURL" $u
- "renderHookName" $renderHookName
- }}
- {{- partial "inline/h-rh-l/validate-fragment.html" $ctx }}
- {{- $href = printf "%s#%s" $href . }}
- {{- end }}
- {{- $attrs = dict "href" $href }}
- {{- else with $.PageInner.Resources.Get $u.Path }}
- {{- /* Destination is a page resource; drop query and fragment. */}}
- {{- $attrs = dict "href" .RelPermalink }}
- {{- else with (and (ne $.Page.BundleType "leaf") ($.Page.CurrentSection.Resources.Get $u.Path)) }}
- {{- /* Destination is a section resource, and current page is not a leaf bundle. */}}
- {{- $attrs = dict "href" .RelPermalink }}
- {{- else with resources.Get $u.Path }}
- {{- /* Destination is a global resource; drop query and fragment. */}}
- {{- $attrs = dict "href" .RelPermalink }}
- {{- else }}
- {{- if eq $errorLevel "warning" }}
- {{- warnf $msg }}
- {{- if and $highlightBrokenLinks hugo.IsDevelopment }}
- {{- $attrs = merge $attrs (dict "class" "broken") }}
- {{- end }}
- {{- else if eq $errorLevel "error" }}
- {{- errorf $msg }}
- {{- end }}
- {{- end }}
- {{- else }}
- {{- with $u.Fragment }}
- {{- /* Destination is on the same page; prepend relative permalink. */}}
- {{- $ctx := dict
- "contentPath" $contentPath
- "errorLevel" $errorLevel
- "page" $.Page
- "parsedURL" $u
- "renderHookName" $renderHookName
- }}
- {{- partial "inline/h-rh-l/validate-fragment.html" $ctx }}
- {{- $attrs = dict "href" (printf "%s#%s" $.Page.RelPermalink .) }}
- {{- else }}
- {{- if eq $errorLevel "warning" }}
- {{- warnf $msg }}
- {{- if and $highlightBrokenLinks hugo.IsDevelopment }}
- {{- $attrs = merge $attrs (dict "class" "broken") }}
- {{- end }}
- {{- else if eq $errorLevel "error" }}
- {{- errorf $msg }}
- {{- end }}
- {{- end }}
- {{- end }}
-{{- end }}
-
-{{- /* Render anchor element. */ -}}
-<a
- {{- with .Title }}title="{{ . }}"{{- end }}
- {{- range $k, $v := $attrs }}
- {{- if $v }}
- {{- printf " %s=%q" $k ($v | transform.HTMLEscape) | safeHTMLAttr }}
- {{- end }}
- {{- end -}}
- >{{ .Text }}</a
->
-
-{{- define "partials/inline/h-rh-l/validate-fragment.html" }}
- {{- /*
- Validates the fragment portion of a link destination.
-
- @context {string} contentPath The page containing the link.
- @context {string} errorLevel The error level when unable to resolve destination; ignore (default), warning, or error.
- @context {page} page The page corresponding to the link destination
- @context {struct} parsedURL The link destination parsed by urls.Parse.
- @context {string} renderHookName The name of the render hook.
- */}}
-
- {{- /* Initialize. */}}
- {{- $contentPath := .contentPath }}
- {{- $errorLevel := .errorLevel }}
- {{- $p := .page }}
- {{- $u := .parsedURL }}
- {{- $renderHookName := .renderHookName }}
-
- {{- /* Validate. */}}
- {{- with $u.Fragment }}
- {{- if $p.Fragments.Identifiers.Contains . }}
- {{- if gt ($p.Fragments.Identifiers.Count .) 1 }}
- {{- $msg := printf "The %q render hook detected duplicate heading IDs %q in %s" $renderHookName . $contentPath }}
- {{- if eq $errorLevel "warning" }}
- {{- warnf $msg }}
- {{- else if eq $errorLevel "error" }}
- {{- errorf $msg }}
- {{- end }}
- {{- end }}
- {{- else }}
- {{- /* Determine target path for warning and error message. */}}
- {{- $targetPath := "" }}
- {{- with $p.File }}
- {{- $targetPath = .Path }}
- {{- else }}
- {{- $targetPath = .Path }}
- {{- end }}
- {{- /* Set common message. */}}
- {{- $msg := printf "The %q render hook was unable to find heading ID %q in %s. See %s" $renderHookName . $targetPath $contentPath }}
- {{- if eq $targetPath $contentPath }}
- {{- $msg = printf "The %q render hook was unable to find heading ID %q in %s" $renderHookName . $targetPath }}
- {{- end }}
- {{- /* Throw warning or error. */}}
- {{- if eq $errorLevel "warning" }}
- {{- warnf $msg }}
- {{- else if eq $errorLevel "error" }}
- {{- errorf $msg }}
- {{- end }}
- {{- end }}
- {{- end }}
-{{- end }}
-
-{{- define "partials/inline/h-rh-l/get-glossary-link-attributes.html" }}
- {{- /*
- Returns the anchor element attributes for a link to the given glossary term.
-
- It first checks for the existence of a glossary page for the given term. If
- no page is found, it then checks for a glossary page for the singular form of
- the term. If neither page exists it throws a warning or error dependent on
- the errorLevel setting
-
- The returned href attribute does not point to the glossary term page.
- Instead, via its fragment, it points to an entry on the glossary page.
-
- @context {string} contentPath The page containing the link.
- @context {string} errorLevel The error level when unable to resolve destination; ignore (default), warning, or error.
- @context {string} renderHookName The name of the render hook.
- @context {string} text The link text.
- */}}
-
- {{- /* Get context.. */}}
- {{- $contentPath := .contentPath }}
- {{- $errorLevel := .errorLevel }}
- {{- $renderHookName := .renderHookName }}
- {{- $text := .text | transform.Plainify | strings.ToLower }}
-
- {{- /* Initialize. */}}
- {{- $glossaryPath := "/quick-reference/glossary" }}
- {{- $termGiven := $text }}
- {{- $termActual := "" }}
- {{- $termSingular := inflect.Singularize $termGiven }}
-
- {{- /* Verify that the glossary page exists. */}}
- {{- $glossaryPage := site.GetPage $glossaryPath }}
- {{- if not $glossaryPage }}
- {{- errorf "The %q render hook was unable to find %s: see %s" $renderHookName $glossaryPath $contentPath }}
- {{- end }}
-
- {{- /* There's a better way to handle this, but it works for now. */}}
- {{- $cheating := dict
- "chaining" "chain"
- "localize" "localization"
- "localized" "localization"
- "paginating" "paginate"
- "walking" "walk"
- "ci/cd" "cicd"
- }}
-
- {{- /* Verify that a glossary term page exists for the given term. */}}
- {{- if site.GetPage (urls.JoinPath $glossaryPath ($termGiven | urlize)) }}
- {{- $termActual = $termGiven }}
- {{- else if site.GetPage (urls.JoinPath $glossaryPath ($termSingular | urlize)) }}
- {{- $termActual = $termSingular }}
- {{- else }}
- {{- $termToTest := index $cheating $termGiven }}
- {{- if site.GetPage (urls.JoinPath $glossaryPath ($termToTest | urlize)) }}
- {{- $termActual = $termToTest }}
- {{- end }}
- {{- end }}
-
- {{- if not $termActual }}
- {{- errorf "The %q render hook was unable to find a glossary page for either the singular or plural form of the term %q: see %s" $renderHookName $termGiven $contentPath }}
- {{- end }}
-
- {{- /* Create the href attribute. */}}
- {{- $href := "" }}
- {{- if $termActual }}
- {{- $href = fmt.Printf "%s#%s" $glossaryPage.RelPermalink (anchorize $termActual) }}
- {{- end }}
-
- {{- return (dict "href" $href) }}
-{{- end -}}
DIR diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
@@ -1,72 +0,0 @@
-<!doctype html>
-<html
- class="h-full antialiased scheme-light dark:scheme-dark"
- lang="{{ or site.Language.LanguageCode `en-US` }}">
- <head>
- <meta charset="utf-8">
- <title>
- {{ .Title }}
- </title>
- <style>
- [x-cloak] {
- display: none !important;
- }
- </style>
- <meta
- name="description"
- content="{{ .Description | default site.Params.description }}">
- {{ partial "layouts/head/head-js.html" . }}
- {{ with (templates.Defer (dict "key" "global")) }}
- {{ $t := debug.Timer "tailwindcss" }}
- {{ with resources.Get "css/styles.css" }}
- {{ $opts := dict
- "inlineImports" true
- "minify" (not hugo.IsDevelopment)
- }}
- {{ with . | css.TailwindCSS $opts }}
- {{ partial "helpers/linkcss.html" (dict "r" .) }}
- {{ end }}
- {{ end }}
- {{ $t.Stop }}
- {{ end }}
- {{ $noop := .WordCount }}
- {{ if .Page.Store.Get "hasMath" }}
- <link
- href="https://cdn.jsdelivr.net/npm/katex@0.16.21/dist/katex.min.css"
- rel="stylesheet">
- {{ end }}
- {{ partial "layouts/head/head.html" . }}
- </head>
- <body
- class="flex flex-col min-h-full bg-white dark:bg-blue-950 kind-{{ .Kind }}">
- {{ partial "layouts/hooks/body-start.html" . }}
- {{/* Layout. */}}
- {{ block "header" . }}
- {{ partial "layouts/header/header.html" . }}
- {{ end }}
- {{ block "hero" . }}
- {{ end }}
- <div class="flex w-full xl:w-6xl h-full flex-auto mx-auto">
- <main
- class="flex-1 mx-auto lg:mx-0 w-full max-w-3x lg:max-w-3x pt-8 lg:pt-14 pb-20 px-main print:pt-0">
- {{ partial "layouts/hooks/body-main-start.html" . }}
- {{ block "main" . }}{{ end }}
- </main>
- {{ block "rightsidebar" . }}
- <aside
- class="py-15 ml-4 xl:ml-12 w-60 hidden lg:relative lg:block lg:flex-none">
- {{ block "rightsidebar_content" . }}{{ end }}
- </aside>
- {{ end }}
- </div>
- {{/* Common icons. */}}
- {{ partial "layouts/icons.html" . }}
- {{/* Common templates. */}}
- {{ partial "layouts/templates.html" . }}
- {{/* Footer. */}}
- {{ block "footer" . }}
- {{ partial "layouts/footer.html" . }}
- {{ end }}
- {{ partial "layouts/hooks/body-end.html" . }}
- </body>
-</html>
DIR diff --git a/layouts/_default/_markup/render-blockquote.html b/layouts/_markup/render-blockquote.html
DIR diff --git a/layouts/_default/_markup/render-codeblock.html b/layouts/_markup/render-codeblock.html
DIR diff --git a/layouts/_markup/render-link.html b/layouts/_markup/render-link.html
@@ -0,0 +1,320 @@
+{{/* prettier-ignore-start */ -}}
+{{- /* Last modified: 2025-01-19T14:44:56-08:00 */}}
+
+{{- /*
+Copyright 2025 Veriphor LLC
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy of
+the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations under
+the License.
+*/}}
+
+{{- /*
+This render hook resolves internal destinations by looking for a matching:
+
+ 1. Content page
+ 2. Page resource (a file in the current page bundle)
+ 3. Section resource (a file in the current section)
+ 4. Global resource (a file in the assets directory)
+
+It skips the section resource lookup if the current page is a leaf bundle.
+
+External destinations are not modified.
+
+You must place global resources in the assets directory. If you have placed
+your resources in the static directory, and you are unable or unwilling to move
+them, you must mount the static directory to the assets directory by including
+both of these entries in your site configuration:
+
+ [[module.mounts]]
+ source = 'assets'
+ target = 'assets'
+
+ [[module.mounts]]
+ source = 'static'
+ target = 'assets'
+
+By default, if this render hook is unable to resolve a destination, including a
+fragment if present, it passes the destination through without modification. To
+emit a warning or error, set the error level in your site configuration:
+
+ [params.render_hooks.link]
+ errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
+
+When you set the error level to warning, and you are in a development
+environment, you can visually highlight broken internal links:
+
+ [params.render_hooks.link]
+ errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
+ highlightBroken = true # true or false (default)
+
+This will add a "broken" class to anchor elements with invalid src attributes.
+Add a rule to your CSS targeting the broken links:
+
+ a.broken {
+ background: #ff0;
+ border: 2px solid #f00;
+ padding: 0.1em 0.2em;
+ }
+
+This render hook may be unable to resolve destinations created with the ref and
+relref shortcodes. Unless you set the error level to ignore you should not use
+either of these shortcodes in conjunction with this render hook.
+
+@context {string} Destination The link destination.
+@context {page} Page A reference to the page containing the link.
+@context {string} PlainText The link description as plain text.
+@context {string} Text The link description.
+@context {string} Title The link title.
+
+@returns {template.html}
+*/ -}}
+{{/* prettier-ignore-end */ -}}
+{{- /* Initialize. */}}
+{{- $renderHookName := "link" }}
+
+{{- /* Verify minimum required version. */}}
+{{- $minHugoVersion := "0.141.0" }}
+{{- if lt hugo.Version $minHugoVersion }}
+ {{- errorf "The %q render hook requires Hugo v%s or later." $renderHookName $minHugoVersion }}
+{{- end }}
+
+{{- /* Error level when unable to resolve destination: ignore, warning, or error. */}}
+{{- $errorLevel := or site.Params.render_hooks.link.errorLevel "ignore" | lower }}
+
+{{- /* If true, adds "broken" class to broken links. Applicable in development environment when errorLevel is warning. */}}
+{{- $highlightBrokenLinks := or site.Params.render_hooks.link.highlightBroken false }}
+
+{{- /* Validate error level. */}}
+{{- if not (in (slice "ignore" "warning" "error") $errorLevel) }}
+ {{- errorf "The %q render hook is misconfigured. The errorLevel %q is invalid. Please check your site configuration." $renderHookName $errorLevel }}
+{{- end }}
+
+{{- /* Determine content path for warning and error messages. */}}
+{{- $contentPath := .Page.String }}
+
+{{- /* Parse destination. */}}
+{{- $u := urls.Parse .Destination }}
+
+{{- /* Set common message. */}}
+{{- $msg := printf "The %q render hook was unable to resolve the destination %q in %s" $renderHookName $u.String $contentPath }}
+
+{{- /* Set attributes for anchor element. */}}
+{{- $attrs := dict "href" $u.String }}
+{{- if eq $u.String "g" }}
+ {{- /* Destination is a glossary term. */}}
+ {{- $ctx := dict
+ "contentPath" $contentPath
+ "errorLevel" $errorLevel
+ "renderHookName" $renderHookName
+ "text" .Text
+ }}
+ {{- $attrs = partial "inline/h-rh-l/get-glossary-link-attributes.html" $ctx }}
+{{- else if $u.IsAbs }}
+ {{- /* Destination is a remote resource. */}}
+ {{- $attrs = merge $attrs (dict "rel" "external") }}
+{{- else }}
+ {{- with $u.Path }}
+ {{- with $p := or ($.PageInner.GetPage .) ($.PageInner.GetPage (strings.TrimRight "/" .)) }}
+ {{- /* Destination is a page. */}}
+ {{- $href := .RelPermalink }}
+ {{- with $u.RawQuery }}
+ {{- $href = printf "%s?%s" $href . }}
+ {{- end }}
+ {{- with $u.Fragment }}
+ {{- $ctx := dict
+ "contentPath" $contentPath
+ "errorLevel" $errorLevel
+ "page" $p
+ "parsedURL" $u
+ "renderHookName" $renderHookName
+ }}
+ {{- partial "inline/h-rh-l/validate-fragment.html" $ctx }}
+ {{- $href = printf "%s#%s" $href . }}
+ {{- end }}
+ {{- $attrs = dict "href" $href }}
+ {{- else with $.PageInner.Resources.Get $u.Path }}
+ {{- /* Destination is a page resource; drop query and fragment. */}}
+ {{- $attrs = dict "href" .RelPermalink }}
+ {{- else with (and (ne $.Page.BundleType "leaf") ($.Page.CurrentSection.Resources.Get $u.Path)) }}
+ {{- /* Destination is a section resource, and current page is not a leaf bundle. */}}
+ {{- $attrs = dict "href" .RelPermalink }}
+ {{- else with resources.Get $u.Path }}
+ {{- /* Destination is a global resource; drop query and fragment. */}}
+ {{- $attrs = dict "href" .RelPermalink }}
+ {{- else }}
+ {{- if eq $errorLevel "warning" }}
+ {{- warnf $msg }}
+ {{- if and $highlightBrokenLinks hugo.IsDevelopment }}
+ {{- $attrs = merge $attrs (dict "class" "broken") }}
+ {{- end }}
+ {{- else if eq $errorLevel "error" }}
+ {{- errorf $msg }}
+ {{- end }}
+ {{- end }}
+ {{- else }}
+ {{- with $u.Fragment }}
+ {{- /* Destination is on the same page; prepend relative permalink. */}}
+ {{- $ctx := dict
+ "contentPath" $contentPath
+ "errorLevel" $errorLevel
+ "page" $.Page
+ "parsedURL" $u
+ "renderHookName" $renderHookName
+ }}
+ {{- partial "inline/h-rh-l/validate-fragment.html" $ctx }}
+ {{- $attrs = dict "href" (printf "%s#%s" $.Page.RelPermalink .) }}
+ {{- else }}
+ {{- if eq $errorLevel "warning" }}
+ {{- warnf $msg }}
+ {{- if and $highlightBrokenLinks hugo.IsDevelopment }}
+ {{- $attrs = merge $attrs (dict "class" "broken") }}
+ {{- end }}
+ {{- else if eq $errorLevel "error" }}
+ {{- errorf $msg }}
+ {{- end }}
+ {{- end }}
+ {{- end }}
+{{- end }}
+
+{{- /* Render anchor element. */ -}}
+<a
+ {{- with .Title }}title="{{ . }}"{{- end }}
+ {{- range $k, $v := $attrs }}
+ {{- if $v }}
+ {{- printf " %s=%q" $k ($v | transform.HTMLEscape) | safeHTMLAttr }}
+ {{- end }}
+ {{- end -}}
+ >{{ .Text }}</a
+>
+
+{{- define "_partials/inline/h-rh-l/validate-fragment.html" }}
+ {{- /*
+ Validates the fragment portion of a link destination.
+
+ @context {string} contentPath The page containing the link.
+ @context {string} errorLevel The error level when unable to resolve destination; ignore (default), warning, or error.
+ @context {page} page The page corresponding to the link destination
+ @context {struct} parsedURL The link destination parsed by urls.Parse.
+ @context {string} renderHookName The name of the render hook.
+ */}}
+
+ {{- /* Initialize. */}}
+ {{- $contentPath := .contentPath }}
+ {{- $errorLevel := .errorLevel }}
+ {{- $p := .page }}
+ {{- $u := .parsedURL }}
+ {{- $renderHookName := .renderHookName }}
+
+ {{- /* Validate. */}}
+ {{- with $u.Fragment }}
+ {{- if $p.Fragments.Identifiers.Contains . }}
+ {{- if gt ($p.Fragments.Identifiers.Count .) 1 }}
+ {{- $msg := printf "The %q render hook detected duplicate heading IDs %q in %s" $renderHookName . $contentPath }}
+ {{- if eq $errorLevel "warning" }}
+ {{- warnf $msg }}
+ {{- else if eq $errorLevel "error" }}
+ {{- errorf $msg }}
+ {{- end }}
+ {{- end }}
+ {{- else }}
+ {{- /* Determine target path for warning and error message. */}}
+ {{- $targetPath := "" }}
+ {{- with $p.File }}
+ {{- $targetPath = .Path }}
+ {{- else }}
+ {{- $targetPath = .Path }}
+ {{- end }}
+ {{- /* Set common message. */}}
+ {{- $msg := printf "The %q render hook was unable to find heading ID %q in %s. See %s" $renderHookName . $targetPath $contentPath }}
+ {{- if eq $targetPath $contentPath }}
+ {{- $msg = printf "The %q render hook was unable to find heading ID %q in %s" $renderHookName . $targetPath }}
+ {{- end }}
+ {{- /* Throw warning or error. */}}
+ {{- if eq $errorLevel "warning" }}
+ {{- warnf $msg }}
+ {{- else if eq $errorLevel "error" }}
+ {{- errorf $msg }}
+ {{- end }}
+ {{- end }}
+ {{- end }}
+{{- end }}
+
+{{- define "_partials/inline/h-rh-l/get-glossary-link-attributes.html" }}
+ {{- /*
+ Returns the anchor element attributes for a link to the given glossary term.
+
+ It first checks for the existence of a glossary page for the given term. If
+ no page is found, it then checks for a glossary page for the singular form of
+ the term. If neither page exists it throws a warning or error dependent on
+ the errorLevel setting
+
+ The returned href attribute does not point to the glossary term page.
+ Instead, via its fragment, it points to an entry on the glossary page.
+
+ @context {string} contentPath The page containing the link.
+ @context {string} errorLevel The error level when unable to resolve destination; ignore (default), warning, or error.
+ @context {string} renderHookName The name of the render hook.
+ @context {string} text The link text.
+ */}}
+
+ {{- /* Get context.. */}}
+ {{- $contentPath := .contentPath }}
+ {{- $errorLevel := .errorLevel }}
+ {{- $renderHookName := .renderHookName }}
+ {{- $text := .text | transform.Plainify | strings.ToLower }}
+
+ {{- /* Initialize. */}}
+ {{- $glossaryPath := "/quick-reference/glossary" }}
+ {{- $termGiven := $text }}
+ {{- $termActual := "" }}
+ {{- $termSingular := inflect.Singularize $termGiven }}
+
+ {{- /* Verify that the glossary page exists. */}}
+ {{- $glossaryPage := site.GetPage $glossaryPath }}
+ {{- if not $glossaryPage }}
+ {{- errorf "The %q render hook was unable to find %s: see %s" $renderHookName $glossaryPath $contentPath }}
+ {{- end }}
+
+ {{- /* There's a better way to handle this, but it works for now. */}}
+ {{- $cheating := dict
+ "chaining" "chain"
+ "localize" "localization"
+ "localized" "localization"
+ "paginating" "paginate"
+ "walking" "walk"
+ "ci/cd" "cicd"
+ }}
+
+ {{- /* Verify that a glossary term page exists for the given term. */}}
+ {{- if site.GetPage (urls.JoinPath $glossaryPath ($termGiven | urlize)) }}
+ {{- $termActual = $termGiven }}
+ {{- else if site.GetPage (urls.JoinPath $glossaryPath ($termSingular | urlize)) }}
+ {{- $termActual = $termSingular }}
+ {{- else }}
+ {{- $termToTest := index $cheating $termGiven }}
+ {{- if site.GetPage (urls.JoinPath $glossaryPath ($termToTest | urlize)) }}
+ {{- $termActual = $termToTest }}
+ {{- end }}
+ {{- end }}
+
+ {{- if not $termActual }}
+ {{- errorf "The %q render hook was unable to find a glossary page for either the singular or plural form of the term %q: see %s" $renderHookName $termGiven $contentPath }}
+ {{- end }}
+
+ {{- /* Create the href attribute. */}}
+ {{- $href := "" }}
+ {{- if $termActual }}
+ {{- $href = fmt.Printf "%s#%s" $glossaryPage.RelPermalink (anchorize $termActual) }}
+ {{- end }}
+
+ {{- return (dict "href" $href) }}
+{{- end -}}
DIR diff --git a/layouts/_default/_markup/render-passthrough.html b/layouts/_markup/render-passthrough.html
DIR diff --git a/layouts/_default/_markup/render-table.html b/layouts/_markup/render-table.html
DIR diff --git a/layouts/partials/docs/functions-aliases.html b/layouts/_partials/docs/functions-aliases.html
DIR diff --git a/layouts/partials/docs/functions-return-type.html b/layouts/_partials/docs/functions-return-type.html
DIR diff --git a/layouts/partials/docs/functions-signatures.html b/layouts/_partials/docs/functions-signatures.html
DIR diff --git a/layouts/partials/helpers/debug/list-item-metadata.html b/layouts/_partials/helpers/debug/list-item-metadata.html
DIR diff --git a/layouts/partials/helpers/funcs/color-from-string.html b/layouts/_partials/helpers/funcs/color-from-string.html
DIR diff --git a/layouts/partials/helpers/funcs/get-github-info.html b/layouts/_partials/helpers/funcs/get-github-info.html
DIR diff --git a/layouts/partials/helpers/funcs/get-remote-data.html b/layouts/_partials/helpers/funcs/get-remote-data.html
DIR diff --git a/layouts/partials/helpers/gtag.html b/layouts/_partials/helpers/gtag.html
DIR diff --git a/layouts/partials/helpers/linkcss.html b/layouts/_partials/helpers/linkcss.html
DIR diff --git a/layouts/partials/helpers/linkjs.html b/layouts/_partials/helpers/linkjs.html
DIR diff --git a/layouts/_partials/helpers/picture.html b/layouts/_partials/helpers/picture.html
@@ -0,0 +1,27 @@
+{{ $image := .image }}
+{{ $width := .width | default 1000 }}
+{{ $width1x := div $width 2 }}
+{{ $imageWebp := $image.Resize (printf "%dx webp" $width) }}
+{{ $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" }}
+<picture>
+ <source
+ srcset="{{ $imageWebp.RelPermalink }}"
+ type="image/webp"
+ media="(min-width: 1200px)">
+ <source
+ srcset="{{ $image.RelPermalink }}"
+ type="image/jpeg"
+ media="(min-width: 1200px)">
+ <source srcset="{{ $image1xWebp.RelPermalink }}" type="image/webp">
+ <source srcset="{{ $image1x.RelPermalink }}" type="image/jpeg">
+ <img
+ class="{{ $class }}"
+ src="{{ $image1x.RelPermalink }}"
+ alt=""
+ loading="{{ $loading }}"
+ width="{{ $image1x.Width }}"
+ height="{{ $image1x.Height }}">
+</picture>
DIR diff --git a/layouts/partials/helpers/validation/validate-keywords.html b/layouts/_partials/helpers/validation/validate-keywords.html
DIR diff --git a/layouts/partials/layouts/blocks/alert.html b/layouts/_partials/layouts/blocks/alert.html
DIR diff --git a/layouts/partials/layouts/blocks/modal.html b/layouts/_partials/layouts/blocks/modal.html
DIR diff --git a/layouts/partials/layouts/breadcrumbs.html b/layouts/_partials/layouts/breadcrumbs.html
DIR diff --git a/layouts/partials/layouts/date.html b/layouts/_partials/layouts/date.html
DIR diff --git a/layouts/partials/layouts/docsheader.html b/layouts/_partials/layouts/docsheader.html
DIR diff --git a/layouts/partials/layouts/explorer.html b/layouts/_partials/layouts/explorer.html
DIR diff --git a/layouts/partials/layouts/footer.html b/layouts/_partials/layouts/footer.html
DIR diff --git a/layouts/partials/layouts/head/head-js.html b/layouts/_partials/layouts/head/head-js.html
DIR diff --git a/layouts/partials/layouts/head/head.html b/layouts/_partials/layouts/head/head.html
DIR diff --git a/layouts/partials/layouts/header/githubstars.html b/layouts/_partials/layouts/header/githubstars.html
DIR diff --git a/layouts/partials/layouts/header/header.html b/layouts/_partials/layouts/header/header.html
DIR diff --git a/layouts/_partials/layouts/header/qr.html b/layouts/_partials/layouts/header/qr.html
@@ -0,0 +1,25 @@
+{{ $t := debug.Timer "qr" }}
+{{ $qr := partial "_inline/qr" (dict
+ "page" $
+ "img_class" "w-10 bg-white view-transition-qr" )
+}}
+{{ $qrBig := partial "_inline/qr" (dict "page" $ "img_class" "w-64 p-4") }}
+{{ $t.Stop }}
+<div
+ class="hidden lg:block cursor-pointer outline-2 hover:outline-3 outline-blue-500 w-10 h-10">
+ {{ partial "layouts/blocks/modal.html" (dict "modal_button" $qr "modal_content" $qrBig "modal_title" (printf "QR code linking to %s" $.Permalink )) }}
+</div>
+
+{{ define "_partials/_inline/qr" }}
+ {{ $img_class := .img_class | default "w-10" }}
+ {{ with images.QR $.page.Permalink (dict "targetDir" "images/qr") }}
+
+ <img
+ src="{{ .RelPermalink }}"
+ width="{{ .Width }}"
+ height="{{ .Height }}"
+ @load="$event.target.classList.remove('_opacity-0')"
+ alt="QR code linking to {{ $.page.Permalink }}"
+ class="{{ $img_class }}">
+ {{ end }}
+{{ end }}
DIR diff --git a/layouts/partials/layouts/header/theme.html b/layouts/_partials/layouts/header/theme.html
DIR diff --git a/layouts/partials/layouts/home/features.html b/layouts/_partials/layouts/home/features.html
DIR diff --git a/layouts/partials/layouts/home/opensource.html b/layouts/_partials/layouts/home/opensource.html
DIR diff --git a/layouts/partials/layouts/home/sponsors.html b/layouts/_partials/layouts/home/sponsors.html
DIR diff --git a/layouts/partials/layouts/hooks/body-end.html b/layouts/_partials/layouts/hooks/body-end.html
DIR diff --git a/layouts/partials/layouts/hooks/body-main-start.html b/layouts/_partials/layouts/hooks/body-main-start.html
DIR diff --git a/layouts/partials/layouts/hooks/body-start.html b/layouts/_partials/layouts/hooks/body-start.html
DIR diff --git a/layouts/partials/layouts/icons.html b/layouts/_partials/layouts/icons.html
DIR diff --git a/layouts/partials/layouts/in-this-section.html b/layouts/_partials/layouts/in-this-section.html
DIR diff --git a/layouts/partials/layouts/page-edit.html b/layouts/_partials/layouts/page-edit.html
DIR diff --git a/layouts/partials/layouts/related.html b/layouts/_partials/layouts/related.html
DIR diff --git a/layouts/partials/layouts/search/algolialogo.html b/layouts/_partials/layouts/search/algolialogo.html
DIR diff --git a/layouts/partials/layouts/search/button.html b/layouts/_partials/layouts/search/button.html
DIR diff --git a/layouts/partials/layouts/search/input.html b/layouts/_partials/layouts/search/input.html
DIR diff --git a/layouts/partials/layouts/search/results.html b/layouts/_partials/layouts/search/results.html
DIR diff --git a/layouts/partials/layouts/templates.html b/layouts/_partials/layouts/templates.html
DIR diff --git a/layouts/partials/layouts/toc.html b/layouts/_partials/layouts/toc.html
DIR diff --git a/layouts/partials/opengraph/get-featured-image.html b/layouts/_partials/opengraph/get-featured-image.html
DIR diff --git a/layouts/partials/opengraph/opengraph.html b/layouts/_partials/opengraph/opengraph.html
DIR diff --git a/layouts/shortcodes/chroma-lexers.html b/layouts/_shortcodes/chroma-lexers.html
DIR diff --git a/layouts/shortcodes/code-toggle.html b/layouts/_shortcodes/code-toggle.html
DIR diff --git a/layouts/shortcodes/datatable-filtered.html b/layouts/_shortcodes/datatable-filtered.html
DIR diff --git a/layouts/shortcodes/datatable.html b/layouts/_shortcodes/datatable.html
DIR diff --git a/layouts/shortcodes/deprecated-in.html b/layouts/_shortcodes/deprecated-in.html
DIR diff --git a/layouts/shortcodes/eturl.html b/layouts/_shortcodes/eturl.html
DIR diff --git a/layouts/shortcodes/glossary-term.html b/layouts/_shortcodes/glossary-term.html
DIR diff --git a/layouts/shortcodes/glossary.html b/layouts/_shortcodes/glossary.html
DIR diff --git a/layouts/shortcodes/hl.html b/layouts/_shortcodes/hl.html
DIR diff --git a/layouts/_shortcodes/img.html b/layouts/_shortcodes/img.html
@@ -0,0 +1,391 @@
+{{/* prettier-ignore-start */ -}}
+{{- /*
+Renders the given image using the given filter, if any.
+
+When using the text filter, provide the arguments in this order:
+
+0. The text
+1. The horizontal offset, in pixels, relative to the left of the image (default 20)
+2. The vertical offset, in pixels, relative to the top of the image (default 20)
+3. The font size in pixels (default 64)
+4. The line height (default 1.2)
+5. The font color (default #ffffff)
+
+When using the padding filter, provide all arguments in this order:
+
+0. Padding top
+1. Padding right
+2. Padding bottom
+3. Padding right
+4. Canvas color
+
+@param {string} src The path to the image which must be a remote, page, or global resource.
+@param {string} [filter] The filter to apply to the image (case-insensitive).
+@param {string} [filterArgs] A comma-delimited list of arguments to pass to the filter.
+@param {bool} [example=false] If true, renders a before/after example.
+@param {int} [exampleWidth=384] Image width, in pixels, when rendering a before/after example.
+
+@example {{< img src="zion-national-park.jpg" >}}
+@example {{< img src="zion-national-park.jpg" alt="Zion National Park" >}}
+
+@example {{< img
+ src="zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="grayscale"
+ >}}
+
+@example {{< img
+ src="zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="process"
+ filterArgs="resize 400x webp"
+ >}}
+
+@example {{< img
+ src="zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="colorize"
+ filterArgs="180,50,20"
+ >}}
+
+@example {{< img
+ src="zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="grayscale"
+ example=true
+ >}}
+
+@example {{< img
+ src="zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="grayscale"
+ example=true
+ exampleWidth=400
+ >}}
+
+@example {{< img
+ src="images/examples/zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="Text"
+ filterArgs="Zion National Park,25,250,56"
+ example=true
+ >}}
+
+@example {{< img
+ src="images/examples/zion-national-park.jpg"
+ alt="Zion National Park"
+ filter="Padding"
+ filterArgs="20,50,20,50,#0705"
+ example=true
+ >}}
+*/ -}}
+{{/* prettier-ignore-end */ -}}
+{{- /* Initialize. */}}
+{{- $alt := "" }}
+{{- $src := "" }}
+{{- $filter := "" }}
+{{- $filterArgs := slice }}
+{{- $example := false }}
+{{- $exampleWidth := 384 }}
+
+{{- /* Default values to use with the text filter. */}}
+{{ $textFilterOpts := dict
+ "xOffset" 20
+ "yOffset" 20
+ "fontSize" 64
+ "lineHeight" 1.2
+ "fontColor" "#ffffff"
+ "fontPath" "https://github.com/google/fonts/raw/refs/heads/main/ofl/lato/Lato-Regular.ttf"
+}}
+
+{{- /* Get and validate parameters. */}}
+{{- with .Get "alt" }}
+ {{- $alt = . }}
+{{- end }}
+
+{{- with .Get "src" }}
+ {{- $src = . }}
+{{- else }}
+ {{- errorf "The %q shortcode requires a file parameter. See %s" .Name .Position }}
+{{- end }}
+
+{{- with .Get "filter" }}
+ {{- $filter = . | lower }}
+{{- end }}
+
+{{- $validFilters := slice
+ "autoorient" "brightness" "colorbalance" "colorize" "contrast" "dither"
+ "gamma" "gaussianblur" "grayscale" "hue" "invert" "mask" "none" "opacity"
+ "overlay" "padding" "pixelate" "process" "saturation" "sepia" "sigmoid" "text"
+ "unsharpmask"
+}}
+
+{{- with $filter }}
+ {{- if not (in $validFilters .) }}
+ {{- errorf "The filter passed to the %q shortcode is invalid. The filter must be one of %s. See %s" $.Name (delimit $validFilters ", " ", or ") $.Position }}
+ {{- end }}
+{{- end }}
+
+{{- with .Get "filterArgs" }}
+ {{- $filterArgs = split . "," }}
+ {{- $filterArgs = apply $filterArgs "trim" "." " " }}
+{{- end }}
+
+{{- if in (slice "false" false 0) (.Get "example") }}
+ {{- $example = false }}
+{{- else if in (slice "true" true 1) (.Get "example") }}
+ {{- $example = true }}
+{{- end }}
+
+{{- with .Get "exampleWidth" }}
+ {{- $exampleWidth = . | int }}
+{{- end }}
+
+{{- /* Get image. */}}
+{{- $ctx := dict "page" .Page "src" $src "name" .Name "position" .Position }}
+{{- $i := partial "inline/get-resource.html" $ctx }}
+
+{{- /* Resize if rendering before/after examples. */}}
+{{- if $example }}
+ {{- $i = $i.Resize (printf "%dx" $exampleWidth) }}
+{{- end }}
+
+{{- /* Create filter. */}}
+{{- $f := "" }}
+{{- $ctx := dict "filter" $filter "args" $filterArgs "name" .Name "position" .Position }}
+{{- if eq $filter "autoorient" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $f = images.AutoOrient }}
+{{- else if eq $filter "brightness" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Brightness (index $filterArgs 0) }}
+{{- else if eq $filter "colorbalance" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage red" "argValue" (index $filterArgs 0) "min" -100 "max" 500) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage green" "argValue" (index $filterArgs 1) "min" -100 "max" 500) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage blue" "argValue" (index $filterArgs 2) "min" -100 "max" 500) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.ColorBalance (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
+{{- else if eq $filter "colorize" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "hue" "argValue" (index $filterArgs 0) "min" 0 "max" 360) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "saturation" "argValue" (index $filterArgs 1) "min" 0 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 2) "min" 0 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Colorize (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
+{{- else if eq $filter "contrast" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Contrast (index $filterArgs 0) }}
+{{- else if eq $filter "dither" }}
+ {{- $f = images.Dither }}
+{{- else if eq $filter "gamma" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "gamma" "argValue" (index $filterArgs 0) "min" 0 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Gamma (index $filterArgs 0) }}
+{{- else if eq $filter "gaussianblur" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "sigma" "argValue" (index $filterArgs 0) "min" 0 "max" 1000) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.GaussianBlur (index $filterArgs 0) }}
+{{- else if eq $filter "grayscale" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $f = images.Grayscale }}
+{{- else if eq $filter "hue" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "shift" "argValue" (index $filterArgs 0) "min" -180 "max" 180) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Hue (index $filterArgs 0) }}
+{{- else if eq $filter "invert" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $f = images.Invert }}
+{{- else if eq $filter "mask" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $ctx := dict "src" (index $filterArgs 0) "name" .Name "position" .Position }}
+ {{- $maskImage := partial "inline/get-resource.html" $ctx }}
+ {{- $f = images.Mask $maskImage }}
+{{- else if eq $filter "opacity" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "opacity" "argValue" (index $filterArgs 0) "min" 0 "max" 1) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Opacity (index $filterArgs 0) }}
+{{- else if eq $filter "overlay" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $ctx := dict "src" (index $filterArgs 0) "name" .Name "position" .Position }}
+ {{- $overlayImg := partial "inline/get-resource.html" $ctx }}
+ {{- $f = images.Overlay $overlayImg (index $filterArgs 1 | float ) (index $filterArgs 2 | float) }}
+{{- else if eq $filter "padding" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 5) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $f = images.Padding
+ (index $filterArgs 0 | int)
+ (index $filterArgs 1 | int)
+ (index $filterArgs 2 | int)
+ (index $filterArgs 3 | int)
+ (index $filterArgs 4)
+ }}
+{{- else if eq $filter "pixelate" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "size" "argValue" (index $filterArgs 0) "min" 0 "max" 1000) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Pixelate (index $filterArgs 0) }}
+{{- else if eq $filter "process" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $f = images.Process (index $filterArgs 0) }}
+{{- else if eq $filter "saturation" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 500) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Saturation (index $filterArgs 0) }}
+{{- else if eq $filter "sepia" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" 0 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Sepia (index $filterArgs 0) }}
+{{- else if eq $filter "sigmoid" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 2) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "midpoint" "argValue" (index $filterArgs 0) "min" 0 "max" 1) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "factor" "argValue" (index $filterArgs 1) "min" -10 "max" 10) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.Sigmoid (index $filterArgs 0) (index $filterArgs 1) }}
+{{- else if eq $filter "text" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $ctx := dict "src" $textFilterOpts.fontPath "name" .Name "position" .Position }}
+ {{- $font := or (partial "inline/get-resource.html" $ctx) }}
+ {{- $fontSize := or (index $filterArgs 3 | int) $textFilterOpts.fontSize }}
+ {{- $lineHeight := math.Max (or (index $filterArgs 4 | float) $textFilterOpts.lineHeight) 1 }}
+ {{- $opts := dict
+ "x" (or (index $filterArgs 1 | int) $textFilterOpts.xOffset)
+ "y" (or (index $filterArgs 2 | int) $textFilterOpts.yOffset)
+ "size" $fontSize
+ "linespacing" (mul (sub $lineHeight 1) $fontSize)
+ "color" (or (index $filterArgs 5) $textFilterOpts.fontColor)
+ "font" $font
+ }}
+ {{- $f = images.Text (index $filterArgs 0) $opts }}
+{{- else if eq $filter "unsharpmask" }}
+ {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
+ {{- template "validate-arg-count" $ctx }}
+ {{- $filterArgs = apply $filterArgs "float" "." }}
+ {{- $ctx = merge $ctx (dict "argName" "sigma" "argValue" (index $filterArgs 0) "min" 0 "max" 500) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "amount" "argValue" (index $filterArgs 1) "min" 0 "max" 100) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $ctx = merge $ctx (dict "argName" "threshold" "argValue" (index $filterArgs 2) "min" 0 "max" 1) }}
+ {{- template "validate-arg-value" $ctx }}
+ {{- $f = images.UnsharpMask (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
+{{- end }}
+
+{{- /* Apply filter. */}}
+{{- $fi := $i }}
+{{- with $f }}
+ {{- $fi = $i.Filter . }}
+{{- end }}
+
+{{- /* Render. */}}
+{{- $class := "border-1 border-gray-300 dark:border-gray-500" }}
+{{- if $example }}
+ <p>Original</p>
+ <img
+ class="{{ $class }}"
+ src="{{ $i.RelPermalink }}"
+ alt="{{ $alt }}">
+ <p>Processed</p>
+ <img
+ class="{{ $class }}"
+ src="{{ $fi.RelPermalink }}"
+ alt="{{ $alt }}">
+{{- else -}}
+ <img
+ src="{{ $fi.RelPermalink }}"
+ alt="{{ $alt }}">
+{{- end }}
+
+{{- define "validate-arg-count" }}
+ {{- $msg := "When using the %q filter, the %q shortcode requires an args parameter with %d %s. See %s" }}
+ {{- if lt (len .args) .argsRequired }}
+ {{- $text := "values" }}
+ {{- if eq 1 .argsRequired }}
+ {{- $text = "value" }}
+ {{- end }}
+ {{- errorf $msg .filter .name .argsRequired $text .position }}
+ {{- end }}
+{{- end }}
+
+{{- define "validate-arg-value" }}
+ {{- $msg := "The %q argument passed to the %q shortcode is invalid. Expected a value in the range [%v,%v], but received %v. See %s" }}
+ {{- if or (lt .argValue .min) (gt .argValue .max) }}
+ {{- errorf $msg .argName .name .min .max .argValue .position }}
+ {{- end }}
+{{- end }}
+
+{{- define "_partials/inline/get-resource.html" }}
+ {{- $r := "" }}
+ {{- $u := urls.Parse .src }}
+ {{- $msg := "The %q shortcode was unable to resolve %s. See %s" }}
+ {{- if $u.IsAbs }}
+ {{- with try (resources.GetRemote $u.String) }}
+ {{- with .Err }}
+ {{- errorf "%s" . }}
+ {{- else with .Value }}
+ {{- /* This is a remote resource. */}}
+ {{- $r = . }}
+ {{- else }}
+ {{- errorf $msg $.name $u.String $.position }}
+ {{- end }}
+ {{- end }}
+ {{- else }}
+ {{- with .page.Resources.Get (strings.TrimPrefix "./" $u.Path) }}
+ {{- /* This is a page resource. */}}
+ {{- $r = . }}
+ {{- else }}
+ {{- with resources.Get $u.Path }}
+ {{- /* This is a global resource. */}}
+ {{- $r = . }}
+ {{- else }}
+ {{- errorf $msg $.name $u.Path $.position }}
+ {{- end }}
+ {{- end }}
+ {{- end }}
+ {{- return $r }}
+{{- end -}}
DIR diff --git a/layouts/shortcodes/imgproc.html b/layouts/_shortcodes/imgproc.html
DIR diff --git a/layouts/shortcodes/include.html b/layouts/_shortcodes/include.html
DIR diff --git a/layouts/shortcodes/list-pages-in-section.html b/layouts/_shortcodes/list-pages-in-section.html
DIR diff --git a/layouts/shortcodes/module-mounts-note.html b/layouts/_shortcodes/module-mounts-note.html
DIR diff --git a/layouts/shortcodes/new-in.html b/layouts/_shortcodes/new-in.html
DIR diff --git a/layouts/_shortcodes/per-lang-config-keys.html b/layouts/_shortcodes/per-lang-config-keys.html
@@ -0,0 +1,71 @@
+{{/* prettier-ignore-start */ -}}
+{{- /*
+Renders a responsive grid of the configuration keys that can be defined
+separately for each language.
+*/ -}}
+{{/* prettier-ignore-end */ -}}
+{{- $siteConfigKeys := slice
+ (dict "baseURL" "/configuration/all/#baseurl")
+ (dict "buildDrafts" "/configuration/all/#builddrafts")
+ (dict "buildExpired" "/configuration/all/#buildexpired")
+ (dict "buildFuture" "/configuration/all/#buildfuture")
+ (dict "canonifyURLs" "/configuration/all/#canonifyurls")
+ (dict "capitalizeListTitles" "/configuration/all/#capitalizelisttitles")
+ (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 "disableLiveReload" "/configuration/all/#disablelivereload")
+ (dict "disablePathToLower" "/configuration/all/#disablepathtolower")
+ (dict "enableEmoji " "/configuration/all/#enableemoji")
+ (dict "frontmatter" "/configuration/front-matter/")
+ (dict "hasCJKLanguage" "/configuration/all/#hascjklanguage")
+ (dict "languageCode" "/configuration/all/#languagecode")
+ (dict "mainSections" "/configuration/all/#mainsections")
+ (dict "markup" "/configuration/markup/")
+ (dict "mediaTypes" "/configuration/media-types/")
+ (dict "menus" "/configuration/menus/")
+ (dict "outputFormats" "/configuration/output-formats")
+ (dict "outputs" "/configuration/outputs/")
+ (dict "page" "/configuration/page/")
+ (dict "pagination" "/configuration/pagination/")
+ (dict "params" "/configuration/params/")
+ (dict "permalinks" "/configuration/permalinks/")
+ (dict "pluralizeListTitles" "/configuration/all/#pluralizelisttitles")
+ (dict "privacy" "/configuration/privacy/")
+ (dict "refLinksErrorLevel" "/configuration/all/#reflinkserrorlevel")
+ (dict "refLinksNotFoundURL" "/configuration/all/#reflinksnotfoundurl")
+ (dict "related" "/configuration/related-content/")
+ (dict "relativeURLs" "/configuration/all/#relativeurls")
+ (dict "removePathAccents" "/configuration/all/#removepathaccents")
+ (dict "renderSegments" "/configuration/all/#rendersegments")
+ (dict "sectionPagesMenu" "/configuration/all/#sectionpagesmenu")
+ (dict "security" "/configuration/security/")
+ (dict "services" "/configuration/services/")
+ (dict "sitemap" "/configuration/sitemap/")
+ (dict "staticDir" "/configuration/all/#staticdir")
+ (dict "summaryLength" "/configuration/all/#summarylength")
+ (dict "taxonomies" "/configuration/taxonomies/")
+ (dict "timeZone" "/configuration/all/#timezone")
+ (dict "title" "/configuration/all/#title")
+ (dict "titleCaseStyle" "/configuration/all/#titlecasestyle")
+}}
+
+{{- $a := len $siteConfigKeys }}
+{{- $b := math.Ceil (div $a 2.) }}
+{{- $c := math.Ceil (div $a 3.) }}
+
+
+<div
+ class="grid grid-flow-col grid-rows-{{ $a }} sm:grid-rows-{{ $b }} md:grid-rows-{{ $c }} gap-1">
+ {{- range $siteConfigKeys }}
+ {{ range $k, $v := . }}
+ {{ $u := urls.Parse $v }}
+ {{ if not (site.GetPage $u.Path) }}
+ {{ errorf "The %q shorcode was unable to find %s. See %s." $.Name $u.Path $.Position }}
+ {{ end }}
+ <a href="{{ $v | relLangURL }}"><code>{{ $k }}</code></a>
+ {{ end }}
+ {{- end }}
+</div>
DIR diff --git a/layouts/shortcodes/quick-reference.html b/layouts/_shortcodes/quick-reference.html
DIR diff --git a/layouts/shortcodes/root-configuration-keys.html b/layouts/_shortcodes/root-configuration-keys.html
DIR diff --git a/layouts/shortcodes/syntax-highlighting-styles.html b/layouts/_shortcodes/syntax-highlighting-styles.html
DIR diff --git a/layouts/baseof.html b/layouts/baseof.html
@@ -0,0 +1,74 @@
+<!doctype html>
+<html
+ class="h-full antialiased scheme-light dark:scheme-dark"
+ lang="{{ or site.Language.LanguageCode `en-US` }}">
+ <head>
+ <meta charset="utf-8">
+ <title>
+ {{ .Title }}
+ </title>
+ <style>
+ [x-cloak] {
+ display: none !important;
+ }
+ </style>
+ <meta
+ name="description"
+ content="{{ .Description | default site.Params.description }}">
+ {{ partial "layouts/head/head-js.html" . }}
+ {{ with (templates.Defer (dict "key" "global")) }}
+ {{ $t := debug.Timer "tailwindcss" }}
+ {{ with resources.Get "css/styles.css" }}
+ {{ $opts := dict
+ "inlineImports" true
+ "minify" (not hugo.IsDevelopment)
+ }}
+ {{ with . | css.TailwindCSS $opts }}
+ {{ partial "helpers/linkcss.html" (dict "r" .) }}
+ {{ end }}
+ {{ end }}
+ {{ $t.Stop }}
+ {{ end }}
+ {{ $noop := .WordCount }}
+ {{ if .Page.Store.Get "hasMath" }}
+ <link
+ href="https://cdn.jsdelivr.net/npm/katex@0.16.21/dist/katex.min.css"
+ rel="stylesheet">
+ {{ end }}
+ {{ partial "layouts/head/head.html" . }}
+ </head>
+ <body
+ class="flex flex-col min-h-full bg-white dark:bg-blue-950 kind-{{ .Kind }}">
+ {{ partial "layouts/hooks/body-start.html" . }}
+ {{/* Layout. */}}
+ {{ block "header" . }}
+ {{ partial "layouts/header/header.html" . }}
+ {{ end }}
+ {{ block "subheader" . }}
+ {{ end }}
+ {{ block "hero" . }}
+ {{ end }}
+ <div class="flex w-full xl:w-6xl h-full flex-auto mx-auto">
+ <main
+ class="flex-1 mx-auto lg:mx-0 w-full max-w-3x lg:max-w-3x pt-8 lg:pt-14 pb-20 px-main print:pt-0">
+ {{ partial "layouts/hooks/body-main-start.html" . }}
+ {{ block "main" . }}{{ end }}
+ </main>
+ {{ block "rightsidebar" . }}
+ <aside
+ class="py-15 ml-4 xl:ml-12 w-60 hidden lg:relative lg:block lg:flex-none">
+ {{ block "rightsidebar_content" . }}{{ end }}
+ </aside>
+ {{ end }}
+ </div>
+ {{/* Common icons. */}}
+ {{ partial "layouts/icons.html" . }}
+ {{/* Common templates. */}}
+ {{ partial "layouts/templates.html" . }}
+ {{/* Footer. */}}
+ {{ block "footer" . }}
+ {{ partial "layouts/footer.html" . }}
+ {{ end }}
+ {{ partial "layouts/hooks/body-end.html" . }}
+ </body>
+</html>
DIR diff --git a/layouts/index.headers b/layouts/home.headers
DIR diff --git a/layouts/index.html b/layouts/home.html
DIR diff --git a/layouts/index.redir b/layouts/home.redir
DIR diff --git a/layouts/_default/list.html b/layouts/list.html
DIR diff --git a/layouts/_default/list.rss.xml b/layouts/list.rss.xml
DIR diff --git a/layouts/partials/helpers/picture.html b/layouts/partials/helpers/picture.html
@@ -1,25 +0,0 @@
-{{ $image := .image }}
-{{ $width := .width | default 1000 }}
-{{ $width1x := div $width 2 }}
-{{ $imageWebp := $image.Resize (printf "%dx webp" $width) }}
-{{ $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" }}
-<picture>
- <source
- srcset="{{ $imageWebp.RelPermalink }}"
- type="image/webp"
- media="(min-width: 1200px)">
- <source
- srcset="{{ $image.RelPermalink }}"
- type="image/jpeg"
- media="(min-width: 1200px)">
- <source srcset="{{ $image1xWebp.RelPermalink }}" type="image/webp">
- <source srcset="{{ $image1x.RelPermalink }}" type="image/jpeg">
- <img
- class="{{ $class }}"
- src="{{ $image1x.RelPermalink }}"
- alt=""
- width="{{ $image1x.Width }}"
- height="{{ $image1x.Height }}">
-</picture>
DIR diff --git a/layouts/partials/layouts/header/qr.html b/layouts/partials/layouts/header/qr.html
@@ -1,25 +0,0 @@
-{{ $t := debug.Timer "qr" }}
-{{ $qr := partial "_inline/qr" (dict
- "page" $
- "img_class" "w-10 bg-white view-transition-qr" )
-}}
-{{ $qrBig := partial "_inline/qr" (dict "page" $ "img_class" "w-64 p-4") }}
-{{ $t.Stop }}
-<div
- class="hidden lg:block cursor-pointer outline-2 hover:outline-3 outline-blue-500 w-10 h-10">
- {{ partial "layouts/blocks/modal.html" (dict "modal_button" $qr "modal_content" $qrBig "modal_title" (printf "QR code linking to %s" $.Permalink )) }}
-</div>
-
-{{ define "partials/_inline/qr" }}
- {{ $img_class := .img_class | default "w-10" }}
- {{ with images.QR $.page.Permalink (dict "targetDir" "images/qr") }}
-
- <img
- src="{{ .RelPermalink }}"
- width="{{ .Width }}"
- height="{{ .Height }}"
- @load="$event.target.classList.remove('_opacity-0')"
- alt="QR code linking to {{ $.page.Permalink }}"
- class="{{ $img_class }}">
- {{ end }}
-{{ end }}
DIR diff --git a/layouts/shortcodes/img.html b/layouts/shortcodes/img.html
@@ -1,391 +0,0 @@
-{{/* prettier-ignore-start */ -}}
-{{- /*
-Renders the given image using the given filter, if any.
-
-When using the text filter, provide the arguments in this order:
-
-0. The text
-1. The horizontal offset, in pixels, relative to the left of the image (default 20)
-2. The vertical offset, in pixels, relative to the top of the image (default 20)
-3. The font size in pixels (default 64)
-4. The line height (default 1.2)
-5. The font color (default #ffffff)
-
-When using the padding filter, provide all arguments in this order:
-
-0. Padding top
-1. Padding right
-2. Padding bottom
-3. Padding right
-4. Canvas color
-
-@param {string} src The path to the image which must be a remote, page, or global resource.
-@param {string} [filter] The filter to apply to the image (case-insensitive).
-@param {string} [filterArgs] A comma-delimited list of arguments to pass to the filter.
-@param {bool} [example=false] If true, renders a before/after example.
-@param {int} [exampleWidth=384] Image width, in pixels, when rendering a before/after example.
-
-@example {{< img src="zion-national-park.jpg" >}}
-@example {{< img src="zion-national-park.jpg" alt="Zion National Park" >}}
-
-@example {{< img
- src="zion-national-park.jpg"
- alt="Zion National Park"
- filter="grayscale"
- >}}
-
-@example {{< img
- src="zion-national-park.jpg"
- alt="Zion National Park"
- filter="process"
- filterArgs="resize 400x webp"
- >}}
-
-@example {{< img
- src="zion-national-park.jpg"
- alt="Zion National Park"
- filter="colorize"
- filterArgs="180,50,20"
- >}}
-
-@example {{< img
- src="zion-national-park.jpg"
- alt="Zion National Park"
- filter="grayscale"
- example=true
- >}}
-
-@example {{< img
- src="zion-national-park.jpg"
- alt="Zion National Park"
- filter="grayscale"
- example=true
- exampleWidth=400
- >}}
-
-@example {{< img
- src="images/examples/zion-national-park.jpg"
- alt="Zion National Park"
- filter="Text"
- filterArgs="Zion National Park,25,250,56"
- example=true
- >}}
-
-@example {{< img
- src="images/examples/zion-national-park.jpg"
- alt="Zion National Park"
- filter="Padding"
- filterArgs="20,50,20,50,#0705"
- example=true
- >}}
-*/ -}}
-{{/* prettier-ignore-end */ -}}
-{{- /* Initialize. */}}
-{{- $alt := "" }}
-{{- $src := "" }}
-{{- $filter := "" }}
-{{- $filterArgs := slice }}
-{{- $example := false }}
-{{- $exampleWidth := 384 }}
-
-{{- /* Default values to use with the text filter. */}}
-{{ $textFilterOpts := dict
- "xOffset" 20
- "yOffset" 20
- "fontSize" 64
- "lineHeight" 1.2
- "fontColor" "#ffffff"
- "fontPath" "https://github.com/google/fonts/raw/refs/heads/main/ofl/lato/Lato-Regular.ttf"
-}}
-
-{{- /* Get and validate parameters. */}}
-{{- with .Get "alt" }}
- {{- $alt = . }}
-{{- end }}
-
-{{- with .Get "src" }}
- {{- $src = . }}
-{{- else }}
- {{- errorf "The %q shortcode requires a file parameter. See %s" .Name .Position }}
-{{- end }}
-
-{{- with .Get "filter" }}
- {{- $filter = . | lower }}
-{{- end }}
-
-{{- $validFilters := slice
- "autoorient" "brightness" "colorbalance" "colorize" "contrast" "dither"
- "gamma" "gaussianblur" "grayscale" "hue" "invert" "mask" "none" "opacity"
- "overlay" "padding" "pixelate" "process" "saturation" "sepia" "sigmoid" "text"
- "unsharpmask"
-}}
-
-{{- with $filter }}
- {{- if not (in $validFilters .) }}
- {{- errorf "The filter passed to the %q shortcode is invalid. The filter must be one of %s. See %s" $.Name (delimit $validFilters ", " ", or ") $.Position }}
- {{- end }}
-{{- end }}
-
-{{- with .Get "filterArgs" }}
- {{- $filterArgs = split . "," }}
- {{- $filterArgs = apply $filterArgs "trim" "." " " }}
-{{- end }}
-
-{{- if in (slice "false" false 0) (.Get "example") }}
- {{- $example = false }}
-{{- else if in (slice "true" true 1) (.Get "example") }}
- {{- $example = true }}
-{{- end }}
-
-{{- with .Get "exampleWidth" }}
- {{- $exampleWidth = . | int }}
-{{- end }}
-
-{{- /* Get image. */}}
-{{- $ctx := dict "page" .Page "src" $src "name" .Name "position" .Position }}
-{{- $i := partial "inline/get-resource.html" $ctx }}
-
-{{- /* Resize if rendering before/after examples. */}}
-{{- if $example }}
- {{- $i = $i.Resize (printf "%dx" $exampleWidth) }}
-{{- end }}
-
-{{- /* Create filter. */}}
-{{- $f := "" }}
-{{- $ctx := dict "filter" $filter "args" $filterArgs "name" .Name "position" .Position }}
-{{- if eq $filter "autoorient" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $f = images.AutoOrient }}
-{{- else if eq $filter "brightness" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Brightness (index $filterArgs 0) }}
-{{- else if eq $filter "colorbalance" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "percentage red" "argValue" (index $filterArgs 0) "min" -100 "max" 500) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "percentage green" "argValue" (index $filterArgs 1) "min" -100 "max" 500) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "percentage blue" "argValue" (index $filterArgs 2) "min" -100 "max" 500) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.ColorBalance (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
-{{- else if eq $filter "colorize" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "hue" "argValue" (index $filterArgs 0) "min" 0 "max" 360) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "saturation" "argValue" (index $filterArgs 1) "min" 0 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 2) "min" 0 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Colorize (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
-{{- else if eq $filter "contrast" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Contrast (index $filterArgs 0) }}
-{{- else if eq $filter "dither" }}
- {{- $f = images.Dither }}
-{{- else if eq $filter "gamma" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "gamma" "argValue" (index $filterArgs 0) "min" 0 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Gamma (index $filterArgs 0) }}
-{{- else if eq $filter "gaussianblur" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "sigma" "argValue" (index $filterArgs 0) "min" 0 "max" 1000) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.GaussianBlur (index $filterArgs 0) }}
-{{- else if eq $filter "grayscale" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $f = images.Grayscale }}
-{{- else if eq $filter "hue" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "shift" "argValue" (index $filterArgs 0) "min" -180 "max" 180) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Hue (index $filterArgs 0) }}
-{{- else if eq $filter "invert" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 0) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $f = images.Invert }}
-{{- else if eq $filter "mask" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $ctx := dict "src" (index $filterArgs 0) "name" .Name "position" .Position }}
- {{- $maskImage := partial "inline/get-resource.html" $ctx }}
- {{- $f = images.Mask $maskImage }}
-{{- else if eq $filter "opacity" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "opacity" "argValue" (index $filterArgs 0) "min" 0 "max" 1) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Opacity (index $filterArgs 0) }}
-{{- else if eq $filter "overlay" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $ctx := dict "src" (index $filterArgs 0) "name" .Name "position" .Position }}
- {{- $overlayImg := partial "inline/get-resource.html" $ctx }}
- {{- $f = images.Overlay $overlayImg (index $filterArgs 1 | float ) (index $filterArgs 2 | float) }}
-{{- else if eq $filter "padding" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 5) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $f = images.Padding
- (index $filterArgs 0 | int)
- (index $filterArgs 1 | int)
- (index $filterArgs 2 | int)
- (index $filterArgs 3 | int)
- (index $filterArgs 4)
- }}
-{{- else if eq $filter "pixelate" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "size" "argValue" (index $filterArgs 0) "min" 0 "max" 1000) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Pixelate (index $filterArgs 0) }}
-{{- else if eq $filter "process" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $f = images.Process (index $filterArgs 0) }}
-{{- else if eq $filter "saturation" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" -100 "max" 500) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Saturation (index $filterArgs 0) }}
-{{- else if eq $filter "sepia" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "percentage" "argValue" (index $filterArgs 0) "min" 0 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Sepia (index $filterArgs 0) }}
-{{- else if eq $filter "sigmoid" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 2) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "midpoint" "argValue" (index $filterArgs 0) "min" 0 "max" 1) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "factor" "argValue" (index $filterArgs 1) "min" -10 "max" 10) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.Sigmoid (index $filterArgs 0) (index $filterArgs 1) }}
-{{- else if eq $filter "text" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 1) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $ctx := dict "src" $textFilterOpts.fontPath "name" .Name "position" .Position }}
- {{- $font := or (partial "inline/get-resource.html" $ctx) }}
- {{- $fontSize := or (index $filterArgs 3 | int) $textFilterOpts.fontSize }}
- {{- $lineHeight := math.Max (or (index $filterArgs 4 | float) $textFilterOpts.lineHeight) 1 }}
- {{- $opts := dict
- "x" (or (index $filterArgs 1 | int) $textFilterOpts.xOffset)
- "y" (or (index $filterArgs 2 | int) $textFilterOpts.yOffset)
- "size" $fontSize
- "linespacing" (mul (sub $lineHeight 1) $fontSize)
- "color" (or (index $filterArgs 5) $textFilterOpts.fontColor)
- "font" $font
- }}
- {{- $f = images.Text (index $filterArgs 0) $opts }}
-{{- else if eq $filter "unsharpmask" }}
- {{- $ctx = merge $ctx (dict "argsRequired" 3) }}
- {{- template "validate-arg-count" $ctx }}
- {{- $filterArgs = apply $filterArgs "float" "." }}
- {{- $ctx = merge $ctx (dict "argName" "sigma" "argValue" (index $filterArgs 0) "min" 0 "max" 500) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "amount" "argValue" (index $filterArgs 1) "min" 0 "max" 100) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $ctx = merge $ctx (dict "argName" "threshold" "argValue" (index $filterArgs 2) "min" 0 "max" 1) }}
- {{- template "validate-arg-value" $ctx }}
- {{- $f = images.UnsharpMask (index $filterArgs 0) (index $filterArgs 1) (index $filterArgs 2) }}
-{{- end }}
-
-{{- /* Apply filter. */}}
-{{- $fi := $i }}
-{{- with $f }}
- {{- $fi = $i.Filter . }}
-{{- end }}
-
-{{- /* Render. */}}
-{{- $class := "border-1 border-gray-300 dark:border-gray-500" }}
-{{- if $example }}
- <p>Original</p>
- <img
- class="{{ $class }}"
- src="{{ $i.RelPermalink }}"
- alt="{{ $alt }}">
- <p>Processed</p>
- <img
- class="{{ $class }}"
- src="{{ $fi.RelPermalink }}"
- alt="{{ $alt }}">
-{{- else -}}
- <img
- src="{{ $fi.RelPermalink }}"
- alt="{{ $alt }}">
-{{- end }}
-
-{{- define "validate-arg-count" }}
- {{- $msg := "When using the %q filter, the %q shortcode requires an args parameter with %d %s. See %s" }}
- {{- if lt (len .args) .argsRequired }}
- {{- $text := "values" }}
- {{- if eq 1 .argsRequired }}
- {{- $text = "value" }}
- {{- end }}
- {{- errorf $msg .filter .name .argsRequired $text .position }}
- {{- end }}
-{{- end }}
-
-{{- define "validate-arg-value" }}
- {{- $msg := "The %q argument passed to the %q shortcode is invalid. Expected a value in the range [%v,%v], but received %v. See %s" }}
- {{- if or (lt .argValue .min) (gt .argValue .max) }}
- {{- errorf $msg .argName .name .min .max .argValue .position }}
- {{- end }}
-{{- end }}
-
-{{- define "partials/inline/get-resource.html" }}
- {{- $r := "" }}
- {{- $u := urls.Parse .src }}
- {{- $msg := "The %q shortcode was unable to resolve %s. See %s" }}
- {{- if $u.IsAbs }}
- {{- with try (resources.GetRemote $u.String) }}
- {{- with .Err }}
- {{- errorf "%s" . }}
- {{- else with .Value }}
- {{- /* This is a remote resource. */}}
- {{- $r = . }}
- {{- else }}
- {{- errorf $msg $.name $u.String $.position }}
- {{- end }}
- {{- end }}
- {{- else }}
- {{- with .page.Resources.Get (strings.TrimPrefix "./" $u.Path) }}
- {{- /* This is a page resource. */}}
- {{- $r = . }}
- {{- else }}
- {{- with resources.Get $u.Path }}
- {{- /* This is a global resource. */}}
- {{- $r = . }}
- {{- else }}
- {{- errorf $msg $.name $u.Path $.position }}
- {{- end }}
- {{- end }}
- {{- end }}
- {{- return $r }}
-{{- end -}}
DIR diff --git a/layouts/shortcodes/per-lang-config-keys.html b/layouts/shortcodes/per-lang-config-keys.html
@@ -1,71 +0,0 @@
-{{/* prettier-ignore-start */ -}}
-{{- /*
-Renders a responsive grid of the configuration keys that can be defined
-separately for each language.
-*/ -}}
-{{/* prettier-ignore-end */ -}}
-{{- $siteConfigKeys := slice
- (dict "baseURL" "/configuration/all/#baseurl")
- (dict "buildDrafts" "/configuration/all/#builddrafts")
- (dict "buildExpired" "/configuration/all/#buildexpired")
- (dict "buildFuture" "/configuration/all/#buildfuture")
- (dict "canonifyURLs" "/configuration/all/#canonifyurls")
- (dict "capitalizeListTitles" "/configuration/all/#capitalizelisttitles")
- (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 "disableLiveReload" "/configuration/all/#disablelivereload")
- (dict "disablePathToLower" "/configuration/all/#disablepathtolower")
- (dict "enableEmoji " "/configuration/all/#enableemoji")
- (dict "frontmatter" "/configuration/front-matter/")
- (dict "hasCJKLanguage" "/configuration/all/#hascjklanguage")
- (dict "languageCode" "/configuration/all/#languagecode")
- (dict "mainSections" "/configuration/all/#mainsections")
- (dict "markup" "/configuration/markup/")
- (dict "mediaTypes" "/configuration/media-types/")
- (dict "menus" "/configuration/menus/")
- (dict "outputFormats" "/configuration/output-formats")
- (dict "outputs" "/configuration/outputs/")
- (dict "page" "/configuration/page/")
- (dict "pagination" "/configuration/pagination/")
- (dict "params" "/configuration/params/")
- (dict "permalinks" "/configuration/permalinks/")
- (dict "pluralizeListTitles" "/configuration/all/#pluralizelisttitles")
- (dict "privacy" "/configuration/privacy/")
- (dict "refLinksErrorLevel" "/configuration/all/#reflinkserrorlevel")
- (dict "refLinksNotFoundURL" "/configuration/all/#reflinksnotfoundurl")
- (dict "related" "/configuration/related-content/")
- (dict "relativeURLs" "/configuration/all/#relativeurls")
- (dict "removePathAccents" "/configuration/all/#removepathaccents")
- (dict "renderSegments" "/configuration/all/#rendersegments")
- (dict "sectionPagesMenu" "/configuration/all/#sectionpagesmenu")
- (dict "security" "/configuration/security/")
- (dict "services" "/configuration/services/")
- (dict "sitemap" "/configuration/sitemap/")
- (dict "staticDir" "/configuration/all/#staticdir")
- (dict "summaryLength" "/configuration/all/#summarylength")
- (dict "taxonomies" "/configuration/taxonomies/")
- (dict "timeZone" "/configuration/all/#timezone")
- (dict "title" "/configuration/all/#title")
- (dict "titleCaseStyle" "/configuration/all/#titlecasestyle")
-}}
-
-{{- $a := len $siteConfigKeys }}
-{{- $b := math.Ceil (div $a 2.) }}
-{{- $c := math.Ceil (div $a 3.) }}
-
-
-<div
- class="grid grid-flow-col grid-rows-{{ $a }} sm:grid-rows-{{ $b }} md:grid-rows-{{ $c }} gap-1">
- {{- range $siteConfigKeys }}
- {{ range $k, $v := . }}
- {{ $u := urls.Parse $v }}
- {{ if not (site.GetPage $u.Path) }}
- {{ errorf "The %q shorcode was unable to find %s. See %s." $.Name $u.Path $.Position }}
- {{ end }}
- <a href="{{ $v | relLangURL }}"><code>{{ $k }}</code></a>
- {{ end }}
- {{- end }}
-</div>
DIR diff --git a/layouts/_default/single.html b/layouts/single.html
DIR diff --git a/netlify.toml b/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"
DIR diff --git a/package.hugo.json b/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"
+ }
+}