https://v0-122-0--gohugoio.netlify.app/methods/shortcode/Recent content in Shortcode methods on HugoHugo -- gohugo.ioenhttps://v0-122-0--gohugoio.netlify.app/methods/shortcode/get/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/get/Specify the parameter by position or by name. When calling a shortcode within markdown, use either positional or named parameters, but not both. Some shortcodes support positional parameters, some support named parameters, and others support both. Refer to the shortcode’s documentation for usage details. Positional parameters This shortcode call uses positional parameters: content/about.md {{< myshortcode "Hello" "world" >}} To retrieve parameters by position: layouts/shortcodes/myshortcode.html {{ printf "%s %s." (.Get 0) (.https://v0-122-0--gohugoio.netlify.app/methods/shortcode/inner/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/inner/This content: content/services.md {{< card title="Product Design" >}} We design the **best** widgets in the world. {{< /card >}} With this shortcode: layouts/shortcodes/card.html <div class="card"> {{ with .Get "title" }} <div class="card-title">{{ . }}</div> {{ end }} <div class="card-content"> {{ trim .Inner "\r\n" }} </div> </div> Is rendered to: <div class="card"> <div class="card-title">Product Design</div> <div class="card-content"> We design the **best** widgets in the world. </div> </div> Content between opening and closing shortcode tags may include leading and/or trailing newlines, depending on placement within the markdown.https://v0-122-0--gohugoio.netlify.app/methods/shortcode/innerdeindent/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/innerdeindent/Similar to the Inner method, InnerDeindent returns the content between opening and closing shortcode tags. However, with InnerDeindent, indentation before the content is removed. This allows us to effectively bypass the rules governing indentation as provided in the CommonMark specification. Consider this markdown, an unordered list with a small gallery of thumbnail images within each list item: content/about.md - Gallery one {{< gallery >}}   {{< /gallery >}} - Gallery two {{< gallery >}} !https://v0-122-0--gohugoio.netlify.app/methods/shortcode/isnamedparams/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/isnamedparams/To support both positional and named parameters when calling a shortcode, use the IsNamedParams method to determine how the shortcode was called. With this shortcode template: layouts/shortcodes/myshortcode.html {{ if .IsNamedParams }} {{ printf "%s %s." (.Get "greeting") (.Get "firstName") }} {{ else }} {{ printf "%s %s." (.Get 0) (.Get 1) }} {{ end }} Both of these calls return the same value: content/about.md {{< myshortcode greeting="Hello" firstName="world" >}} {{< myshortcode "Hello" "world" >}}https://v0-122-0--gohugoio.netlify.app/methods/shortcode/name/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/name/The Name method is useful for error reporting. For example, if your shortcode requires a “greeting” parameter: layouts/shortcodes/myshortcode.html {{ $greeting := "" }} {{ with .Get "greeting" }} {{ $greeting = . }} {{ else }} {{ errorf "The %q shortcode requires a 'greeting' parameter. See %s" .Name .Position }} {{ end }} In the absence of a “greeting” parameter, Hugo will throw an error message and fail the build:https://v0-122-0--gohugoio.netlify.app/methods/shortcode/ordinal/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/ordinal/The Ordinal method returns the zero-based ordinal of the shortcode in relation to its parent. If the parent is the page itself, the ordinal represents the position of this shortcode in the page content. This method is useful for, among other things, assigning unique element IDs when a shortcode is called two or more times from the same page. For example: content/about.md {{< img src="images/a.jpg" >}} {{< img src="images/b.jpg" >}} This shortcode performs error checking, then renders an HTML img element with a unique id attribute:https://v0-122-0--gohugoio.netlify.app/methods/shortcode/page/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/page/With this content: content/books/les-miserables.md yaml   toml   json   --- author: Victor Hugo isbn: 978-0451419439 publication_year: 1862 title: Les Misérables --- +++ author = 'Victor Hugo' isbn = '978-0451419439' publication_year = 1862 title = 'Les Misérables' +++ { "author": "Victor Hugo", "isbn": "978-0451419439", "publication_year": 1862, "title": "Les Misérables" } Calling this shortcode: {{< book-details >}} We can access the front matter values using the Page method: layouts/shortcodes/book-details.html <ul> <li>Title: {{ .https://v0-122-0--gohugoio.netlify.app/methods/shortcode/params/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/params/When you call a shortcode using positional parameters, the Params method returns a slice. content/about.md {{< myshortcode "Hello" "world" >}} layouts/shortcodes/myshortcode.html {{ index .Params 0 }} → Hello {{ index .Params 1 }} → world When you call a shortcode using named parameters, the Params method returns a map. content/about.md {{< myshortcode greeting="Hello" name="world" >}} layouts/shortcodes/myshortcode.html {{ .Params.greeting }} → Hello {{ .Params.name }} → worldhttps://v0-122-0--gohugoio.netlify.app/methods/shortcode/parent/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/parent/This is useful for inheritance of common shortcode parameters from the root. In this contrived example, the “greeting” shortcode is the parent, and the “now” shortcode is child. content/welcome.md {{< greeting dateFormat="Jan 2, 2006" >}} Welcome. Today is {{< now >}}. {{< /greeting >}} layouts/shortcodes/greeting.html <div class="greeting"> {{ trim .Inner "\r\n" | .Page.RenderString }} </div> layouts/shortcodes/now.html {{- $dateFormat := "January 2, 2006 15:04:05" }} {{- with .Params }} {{- with .https://v0-122-0--gohugoio.netlify.app/methods/shortcode/position/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/position/The Position method is useful for error reporting. For example, if your shortcode requires a “greeting” parameter: layouts/shortcodes/myshortcode.html {{ $greeting := "" }} {{ with .Get "greeting" }} {{ $greeting = . }} {{ else }} {{ errorf "The %q shortcode requires a 'greeting' parameter. See %s" .Name .Position }} {{ end }} In the absence of a “greeting” parameter, Hugo will throw an error message and fail the build:https://v0-122-0--gohugoio.netlify.app/methods/shortcode/ref/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/ref/The map of option contains: path (string) The path to the page, relative to the content directory. Required. lang (string) The language (site) to search for the page. Default is the current language. Optional. outputFormat (string) The output format to search for the page. Default is the current output format. Optional. The examples below show the rendered output when visiting a page on the English language version of the site:https://v0-122-0--gohugoio.netlify.app/methods/shortcode/relref/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/relref/The map of option contains: path (string) The path to the page, relative to the content directory. Required. lang (string) The language (site) to search for the page. Default is the current language. Optional. outputFormat (string) The output format to search for the page. Default is the current output format. Optional. The examples below show the rendered output when visiting a page on the English language version of the site:https://v0-122-0--gohugoio.netlify.app/methods/shortcode/scratch/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/scratch/The Scratch method within a shortcode creates a scratch pad to store and manipulate data. The scratch pad is scoped to the shortcode, and is reset on server rebuilds. With the introduction of the newScratch function, and the ability to assign values to template variables after initialization, the Scratch method within a shortcode is obsolete. Methods Set Sets the value of a given key. {{ .Scratch.Set "greeting" "Hello" }} Get Gets the value of a given key.https://v0-122-0--gohugoio.netlify.app/methods/shortcode/site/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/shortcode/site/See Site methods. {{ .Site.Title }}