https://v0-122-0--gohugoio.netlify.app/functions/collections/Recent content in Collections functions on HugoHugo -- gohugo.ioenhttps://v0-122-0--gohugoio.netlify.app/functions/collections/after/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/after/The following shows after being used in conjunction with the slicefunction: {{ $data := slice "one" "two" "three" "four" }} <ul> {{ range after 2 $data }} <li>{{ . }}</li> {{ end }} </ul> The template above is rendered to: <ul> <li>three</li> <li>four</li> </ul> Example of after with first: 2nd–4th most recent articles You can use after in combination with the first function and Hugo’s powerful sorting methods. Let’s assume you have a list page at example.https://v0-122-0--gohugoio.netlify.app/functions/collections/append/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/append/This function appends all elements, excluding the last, to the last element. This allows pipe constructs as shown below. Append a single element to a slice: {{ $s := slice "a" "b" }} {{ $s }} → [a b] {{ $s = $s | append "c" }} {{ $s }} → [a b c] Append two elements to a slice: {{ $s := slice "a" "b" }} {{ $s }} → [a b] {{ $s = $s | append "c" "d" }} {{ $s }} → [a b c d] Append two elements, as a slice, to a slice.https://v0-122-0--gohugoio.netlify.app/functions/collections/apply/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/apply/The apply function takes three or more arguments, depending on the function being applied to the collection elements. The first argument is the collection itself, the second argument is the function name, and the remaining arguments are passed to the function, with the string "." representing the collection element. {{ $s := slice "hello" "world" }} {{ $s = apply $s "strings.FirstUpper" "." }} {{ $s }} → [Hello World] {{ $s = apply $s "strings.https://v0-122-0--gohugoio.netlify.app/functions/collections/complement/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/complement/To find the elements within $c3 that do not exist in $c1 or $c2: {{ $c1 := slice 3 }} {{ $c2 := slice 4 5 }} {{ $c3 := slice 1 2 3 4 5 }} {{ complement $c1 $c2 $c3 }} → [1 2] Make your code simpler to understand by using a chained pipeline: {{ $c3 | complement $c1 $c2 }} → [1 2] You can also use the complement function with page collections.https://v0-122-0--gohugoio.netlify.app/functions/collections/delimit/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/delimit/Delimit a slice: {{ $s := slice "b" "a" "c" }} {{ delimit $s ", " }} → b, a, c {{ delimit $s ", " " and "}} → b, a and c Delimit a map: The delimit function sorts maps by key, returning the values. {{ $m := dict "b" 2 "a" 1 "c" 3 }} {{ delimit $m ", " }} → 1, 2, 3 {{ delimit $m ", " " and "}} → 1, 2 and 3https://v0-122-0--gohugoio.netlify.app/functions/collections/dictionary/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/dictionary/{{ $m := dict "a" 1 "b" 2 }} The above produces this data structure: { "a": 1, "b": 2 } Note that the key can be either a string or a string slice. The latter is useful to create a deeply nested structure, e.g.: {{ $m := dict (slice "a" "b" "c") "value" }} The above produces this data structure: { "a": { "b": { "c": "value" } } } Pass values to a partial template The partial below creates an SVG and expects fill, height and width from the caller:https://v0-122-0--gohugoio.netlify.app/functions/collections/first/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/first/{{ range first 5 .Pages }} {{ .Render "summary" }} {{ end }} Set N to zero to return an empty collection. {{ $emptyPageCollection := first 0 .Pages}} Use first and where together. {{ range where .Pages "Section" "articles" | first 5 }} {{ .Render "summary" }} {{ end }}https://v0-122-0--gohugoio.netlify.app/functions/collections/group/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/group/{{ $new := .Site.RegularPages | first 10 | group "New" }} {{ $old := .Site.RegularPages | last 10 | group "Old" }} {{ $groups := slice $new $old }} {{ range $groups }} <h3>{{ .Key }}{{/* Prints "New", "Old" */}}</h3> <ul> {{ range .Pages }} <li> <a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a> <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> </li> {{ end }} </ul> {{ end }} The page group you get from group is of the same type you get from the built-in group methods in Hugo.https://v0-122-0--gohugoio.netlify.app/functions/collections/in/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/in/The SET can be an array, slice, or string. {{ $s := slice "a" "b" "c" }} {{ in $s "b" }} → true {{ $s := slice 1 2 3 }} {{ in $s 2 }} → true {{ $s := slice 1.11 2.22 3.33 }} {{ in $s 2.22 }} → true {{ $s := "abc" }} {{ in $s "b" }} → truehttps://v0-122-0--gohugoio.netlify.app/functions/collections/indexfunction/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/indexfunction/The index functions returns the result of indexing its first argument by the following arguments. Each indexed item must be a map or a slice, e.g.: {{ $slice := slice "a" "b" "c" }} {{ index $slice 0 }} → a {{ index $slice 1 }} → b {{ $map := dict "a" 100 "b" 200 }} {{ index $map "b" }} → 200 The function takes multiple indices as arguments, and this can be used to get nested values, e.https://v0-122-0--gohugoio.netlify.app/functions/collections/intersect/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/intersect/A useful example is to use it as AND filters when combined with where: {{ $pages := where .Site.RegularPages "Type" "not in" (slice "page" "about") }} {{ $pages := $pages | union (where .Site.RegularPages "Params.pinned" true) }} {{ $pages := $pages | intersect (where .Site.RegularPages "Params.images" "!=" nil) }} The above fetches regular pages not of page or about type unless they are pinned. And finally, we exclude all pages with no images set in Page parameters.https://v0-122-0--gohugoio.netlify.app/functions/collections/isset/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/isset/For example, consider this site configuration: hugo. yaml   toml   json   params: showHeroImage: false [params] showHeroImage = false { "params": { "showHeroImage": false } } It the value of showHeroImage is true, we can detect that it exists using either if or with: {{ if site.Params.showHeroImage }} {{ site.Params.showHeroImage }} → true {{ end }} {{ with site.Params.showHeroImage }} {{ . }} → true {{ end }} But if the value of showHeroImage is false, we can’t use either if or with to detect its existence.https://v0-122-0--gohugoio.netlify.app/functions/collections/keyvals/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/keyvals/The primary application for this function is the definition of the namedSlices parameter in the options map passed to the Related method on the Pages object. See related content. {{ $kv := keyVals "foo" "a" "b" "c" }} The resulting data structure is: { "Key": "foo", "Values": [ "a", "b", "c" ] } To extract the key and values: {{ $kv.Key }} → foo {{ $kv.Values }} → [a b c]https://v0-122-0--gohugoio.netlify.app/functions/collections/last/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/last/{{ range last 10 .Pages }} {{ .Render "summary" }} {{ end }} Set N to zero to return an empty collection. {{ $emptyPageCollection := last 0 .Pages}} Use last and [where] together. {{ range where .Pages "Section" "articles" | last 5 }} {{ .Render "summary" }} {{ end }}https://v0-122-0--gohugoio.netlify.app/functions/collections/merge/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/merge/Returns the result of merging two or more maps from left to right. If a key already exists, merge updates its value. If a key is absent, merge inserts the value under the new key. Key handling is case-insensitive. The following examples use these map definitions: {{ $m1 := dict "x" "foo" }} {{ $m2 := dict "x" "bar" "y" "wibble" }} {{ $m3 := dict "x" "baz" "y" "wobble" "z" (dict "a" "huey") }} Example 1https://v0-122-0--gohugoio.netlify.app/functions/collections/newscratch/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/newscratch/The collections.NewScratch function creates a locally scoped scratch pad to store and manipulate data. To create a scratch pad that is attached to a Page object, use the Scratch or Store method. Methods Set Sets the value of a given key. {{ $s := newScratch }} {{ $s.Set "greeting" "Hello" }} Get Gets the value of a given key. {{ $s := newScratch }} {{ $s.Set "greeting" "Hello" }} {{ $s.https://v0-122-0--gohugoio.netlify.app/functions/collections/querify/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/querify/querify takes a set or slice of key-value pairs and returns a query string that can be appended to a URL. The following examples create a link to a search results page on Google. <a href="https://www.google.com?{{ (querify "q" "test" "page" 3) | safeURL }}">Search</a> {{ $qs := slice "q" "test" "page" 3 }} <a href="https://www.google.com?{{ (querify $qs) | safeURL }}">Search</a> Both of these examples render the following HTML: <a href="https://www.google.com?page=3&q=test">Search</a>https://v0-122-0--gohugoio.netlify.app/functions/collections/reverse/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/reverse/{{ slice 2 1 3 | collections.Reverse }} → [3 1 2]https://v0-122-0--gohugoio.netlify.app/functions/collections/seq/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/seq/{{ seq 2 }} → [1 2] {{ seq 0 2 }} → [0 1 2] {{ seq -2 2 }} → [-2 -1 0 1 2] {{ seq -2 2 2 }} → [-2 0 2] A contrived example of iterating over a sequence of integers: {{ $product := 1 }} {{ range seq 4 }} {{ $product = mul $product . }} {{ end }} {{ $product }} → 24 The slice created by the seq function is limited to 2000 elements.https://v0-122-0--gohugoio.netlify.app/functions/collections/shuffle/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/shuffle/{{ shuffle (seq 1 2 3) }} → [3 1 2] {{ shuffle (slice "a" "b" "c") }} → [b a c] The result will vary from one build to the next.https://v0-122-0--gohugoio.netlify.app/functions/collections/slice/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/slice/{{ $s := slice "a" "b" "c" }} {{ $s }} → [a b c]https://v0-122-0--gohugoio.netlify.app/functions/collections/sort/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/sort/The KEY is optional when sorting slices in ascending order, otherwise it is required. When sorting slices, use the literal value in place of the KEY. See examples below. The ORDER may be either asc (ascending) or desc (descending). The default sort order is ascending. Sort a slice The examples below assume this site configuration: hugo. yaml   toml   json   params: grades: - b - a - c [params] grades = ['b', 'a', 'c'] { "params": { "grades": [ "b", "a", "c" ] } } Ascending order Sort slice elements in ascending order using either of these constructs:https://v0-122-0--gohugoio.netlify.app/functions/collections/symdiff/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/symdiff/Example: {{ slice 1 2 3 | symdiff (slice 3 4) }} → [1 2 4] Also see https://en.wikipedia.org/wiki/Symmetric_difference.https://v0-122-0--gohugoio.netlify.app/functions/collections/union/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/union/Given two arrays (or slices) A and B, this function will return a new array that contains the elements or objects that belong to either A or to B or to both. {{ union (slice 1 2 3) (slice 3 4 5) }} <!-- returns [1 2 3 4 5] --> {{ union (slice 1 2 3) nil }} <!-- returns [1 2 3] --> {{ union nil (slice 1 2 3) }} <!https://v0-122-0--gohugoio.netlify.app/functions/collections/uniq/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/uniq/{{ slice 1 3 2 1 | uniq }} → [1 3 2]https://v0-122-0--gohugoio.netlify.app/functions/collections/where/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/collections/where/The where function returns the given collection, removing elements that do not satisfy the comparison condition. The comparison condition is comprised of the KEY, OPERATOR, and VALUE arguments: collections.Where COLLECTION KEY [OPERATOR] VALUE -------------------- comparison condition Hugo will test for equality if you do not provide an OPERATOR argument. For example: {{ $pages := where .Site.RegularPages "Section" "books" }} {{ $books := where .Site.Data.books "genres" "suspense" }} Arguments The where function takes three or four arguments.