summaryrefslogtreecommitdiffstats
path: root/docs/content/en/shortcodes
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/shortcodes')
-rwxr-xr-xdocs/content/en/shortcodes/details.md2
-rwxr-xr-xdocs/content/en/shortcodes/figure.md2
-rwxr-xr-xdocs/content/en/shortcodes/gist.md2
-rwxr-xr-xdocs/content/en/shortcodes/highlight.md4
-rwxr-xr-xdocs/content/en/shortcodes/instagram.md2
-rwxr-xr-xdocs/content/en/shortcodes/param.md2
-rwxr-xr-xdocs/content/en/shortcodes/qr.md2
-rwxr-xr-xdocs/content/en/shortcodes/ref.md2
-rwxr-xr-xdocs/content/en/shortcodes/relref.md10
-rwxr-xr-xdocs/content/en/shortcodes/vimeo.md4
-rwxr-xr-xdocs/content/en/shortcodes/x.md2
-rwxr-xr-xdocs/content/en/shortcodes/youtube.md4
12 files changed, 19 insertions, 19 deletions
diff --git a/docs/content/en/shortcodes/details.md b/docs/content/en/shortcodes/details.md
index 94502ac1c..421fb4e66 100755
--- a/docs/content/en/shortcodes/details.md
+++ b/docs/content/en/shortcodes/details.md
@@ -9,7 +9,7 @@ keywords: []
{{< new-in 0.140.0 />}}
> [!note]
-> To override Hugo's embedded `details` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `details` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
diff --git a/docs/content/en/shortcodes/figure.md b/docs/content/en/shortcodes/figure.md
index 74af52fe7..2234bb3c5 100755
--- a/docs/content/en/shortcodes/figure.md
+++ b/docs/content/en/shortcodes/figure.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `figure` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `figure` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
diff --git a/docs/content/en/shortcodes/gist.md b/docs/content/en/shortcodes/gist.md
index fd2b468ab..03314da0f 100755
--- a/docs/content/en/shortcodes/gist.md
+++ b/docs/content/en/shortcodes/gist.md
@@ -10,7 +10,7 @@ expiryDate: 2027-02-01 # deprecated 2025-02-01 in v0.143.0
{{< deprecated-in 0.143.0 >}}
The `gist` shortcode was deprecated in version 0.143.0 and will be removed in a future release. To continue embedding GitHub Gists in your content, you'll need to create a custom shortcode:
-1. Create a new file: Create a file named `gist.html` within the `layouts/shortcodes` directory.
+1. Create a new file: Create a file named `gist.html` within the `layouts/_shortcodes` directory.
1. Copy the source code: Paste the [original source code]({{% eturl gist %}}) of the gist shortcode into the newly created `gist.html` file.
This will allow you to maintain the functionality of embedding GitHub Gists in your content after the deprecation of the original shortcode.
diff --git a/docs/content/en/shortcodes/highlight.md b/docs/content/en/shortcodes/highlight.md
index 371a3d46e..de90f64f3 100755
--- a/docs/content/en/shortcodes/highlight.md
+++ b/docs/content/en/shortcodes/highlight.md
@@ -7,7 +7,7 @@ keywords: [highlight]
---
> [!note]
-> To override Hugo's embedded `highlight` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `highlight` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
> [!note]
> With the Markdown [content format], the `highlight` shortcode is rarely needed because, by default, Hugo automatically applies syntax highlighting to fenced code blocks.
@@ -77,7 +77,7 @@ This is some {{< highlight go "hl_inline=true, noClasses=true" >}}fmt.Println("i
Given the verbosity of the example above, if you need to frequently highlight inline code snippets, create your own shortcode using a shorter name with preset options.
-```go-html-template {file="layouts/shortcodes/hl.html"}
+```go-html-template {file="layouts/_shortcodes/hl.html"}
{{ $code := .Inner | strings.TrimSpace }}
{{ $lang := or (.Get 0) "go" }}
{{ $opts := dict "hl_inline" true "noClasses" true }}
diff --git a/docs/content/en/shortcodes/instagram.md b/docs/content/en/shortcodes/instagram.md
index 3256790c6..4ee558c00 100755
--- a/docs/content/en/shortcodes/instagram.md
+++ b/docs/content/en/shortcodes/instagram.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `instagram` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `instagram` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
diff --git a/docs/content/en/shortcodes/param.md b/docs/content/en/shortcodes/param.md
index 133b2322a..1a782056f 100755
--- a/docs/content/en/shortcodes/param.md
+++ b/docs/content/en/shortcodes/param.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `param` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `param` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
The `param` shortcode renders a parameter from front matter, falling back to a site parameter of the same name. The shortcode throws an error if the parameter does not exist.
diff --git a/docs/content/en/shortcodes/qr.md b/docs/content/en/shortcodes/qr.md
index 98d6cee4c..27d9ae02f 100755
--- a/docs/content/en/shortcodes/qr.md
+++ b/docs/content/en/shortcodes/qr.md
@@ -9,7 +9,7 @@ keywords: []
{{< new-in 0.141.0 />}}
> [!note]
-> To override Hugo's embedded `qr` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `qr` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
The `qr` shortcode encodes the given text into a [QR code] using the specified options and renders the resulting image.
diff --git a/docs/content/en/shortcodes/ref.md b/docs/content/en/shortcodes/ref.md
index a52c2bf6e..b38413c63 100755
--- a/docs/content/en/shortcodes/ref.md
+++ b/docs/content/en/shortcodes/ref.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `ref` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> 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 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.
diff --git a/docs/content/en/shortcodes/relref.md b/docs/content/en/shortcodes/relref.md
index 219eae81a..d4f4c2425 100755
--- a/docs/content/en/shortcodes/relref.md
+++ b/docs/content/en/shortcodes/relref.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `relref` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> 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 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.
@@ -30,13 +30,13 @@ The `relref` shortcode typically provides the destination for a Markdown link.
The following examples show the rendered output for a page on the English version of the site:
```md
-[Link A]({{%/* ref "/books/book-1" */%}})
+[Link A]({{%/* relref "/books/book-1" */%}})
-[Link B]({{%/* ref path="/books/book-1" */%}})
+[Link B]({{%/* relref path="/books/book-1" */%}})
-[Link C]({{%/* ref path="/books/book-1" lang="de" */%}})
+[Link C]({{%/* relref path="/books/book-1" lang="de" */%}})
-[Link D]({{%/* ref path="/books/book-1" lang="de" outputFormat="json" */%}})
+[Link D]({{%/* relref path="/books/book-1" lang="de" outputFormat="json" */%}})
```
Rendered:
diff --git a/docs/content/en/shortcodes/vimeo.md b/docs/content/en/shortcodes/vimeo.md
index 1164ce997..40daaeec2 100755
--- a/docs/content/en/shortcodes/vimeo.md
+++ b/docs/content/en/shortcodes/vimeo.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `vimeo` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `vimeo` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
@@ -30,7 +30,7 @@ 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.
+: (string) The video `id`. Optional if the `id` is the first and only positional argument.
allowFullScreen
: {{< new-in 0.146.0 />}}
diff --git a/docs/content/en/shortcodes/x.md b/docs/content/en/shortcodes/x.md
index f1eebdaf2..dbce7e613 100755
--- a/docs/content/en/shortcodes/x.md
+++ b/docs/content/en/shortcodes/x.md
@@ -9,7 +9,7 @@ keywords: []
{{< new-in 0.141.0 />}}
> [!note]
-> To override Hugo's embedded `x` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `x` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
diff --git a/docs/content/en/shortcodes/youtube.md b/docs/content/en/shortcodes/youtube.md
index ed3cf0632..d9f5fb739 100755
--- a/docs/content/en/shortcodes/youtube.md
+++ b/docs/content/en/shortcodes/youtube.md
@@ -7,7 +7,7 @@ keywords: []
---
> [!note]
-> To override Hugo's embedded `youtube` shortcode, copy the [source code] to a file with the same name in the `layouts/shortcodes` directory.
+> To override Hugo's embedded `youtube` shortcode, copy the [source code] to a file with the same name in the `layouts/_shortcodes` directory.
## Example
@@ -30,7 +30,7 @@ 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.
+: (`string`) The video `id`. Optional if the `id` is the first and only positional argument.
allowFullScreen
: {{< new-in 0.125.0 />}}