Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/gohugoioTheme2.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-04-29 13:52:09 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-04-29 19:37:52 +0300
commitd4d2560162b76dee9fcff4891bc9905fa630690f (patch)
treeca6d8d4e3c4eea39079c322bf4ac03d2ebc4935e
parent21420e463d8226be376f58457fe95cd38c9a4c4b (diff)
Content
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/cast/cast/index.md15
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/collections/collections/index.md202
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/compare/compare/index.md44
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/crypto/crypto/index.md25
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/data/data/index.md10
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/debug/debug/index.md7
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/encoding/encoding/index.md15
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/fmt/fmt/index.md36
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/images/images/index.md11
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/inflect/inflect/index.md27
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/js/js/index.md5
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/lang/lang/index.md49
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/math/math/index.md73
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/openapi/openapi3/openapi/openapi3/index.md4
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/os/os/index.md27
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/partials/partials/index.md12
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/path/path/index.md70
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/reflect/reflect/index.md10
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/safe/safe/index.md35
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/strings/strings/index.md160
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/templates/templates/index.md7
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/time/time/index.md29
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/transform/transform/index.md56
-rw-r--r--exampleSite/content/en/documentation/reference/functions/tpl/urls/urls/index.md55
-rw-r--r--exampleSite/content/en/documentation/reference/gotypes/index.md10
-rw-r--r--exampleSite/content/en/documentation/reference/objects/hugo/index.md17
-rw-r--r--exampleSite/content/en/documentation/reference/objects/langs/language/index.md3
-rw-r--r--exampleSite/content/en/documentation/reference/objects/media/type/index.md19
-rw-r--r--exampleSite/content/en/documentation/reference/objects/navigation/menus/index.md37
-rw-r--r--exampleSite/content/en/documentation/reference/objects/site/index.md20
-rw-r--r--exampleSite/go.mod6
-rw-r--r--exampleSite/go.sum3
32 files changed, 643 insertions, 456 deletions
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/cast/cast/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/cast/cast/index.md
index afc80c0..9cdaf81 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/cast/cast/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/cast/cast/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## cast.ToFloat {#cast_namespace_tofloat}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(v [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-ToFloat converts the given value to a float.
+ToFloat converts the given value to a float.
+
{{< docs/func-aliases "cast.ToFloat" >}}
{{< docs/func-examples "cast.ToFloat" >}}
@@ -46,11 +47,12 @@ ToFloat converts the given value to a float.
## cast.ToInt {#cast_namespace_toint}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(v [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-ToInt converts the given value to an int.
+ToInt converts the given value to an int.
+
{{< docs/func-aliases "cast.ToInt" >}}
{{< docs/func-examples "cast.ToInt" >}}
@@ -62,11 +64,12 @@ ToInt converts the given value to an int.
## cast.ToString {#cast_namespace_tostring}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(v [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-ToString converts the given value to a string.
+ToString converts the given value to a string.
+
{{< docs/func-aliases "cast.ToString" >}}
{{< docs/func-examples "cast.ToString" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/collections/collections/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/collections/collections/index.md
index a0a43f4..d330719 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/collections/collections/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/collections/collections/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## collections.After {#collections_namespace_after}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(index [any](/documentation/reference/gotypes/#any), seq [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-After returns all the items after the first N in a rangeable list.
+After returns all the items after the first N in a rangeable list.
+
{{< docs/func-aliases "collections.After" >}}
{{< docs/func-examples "collections.After" >}}
@@ -46,26 +47,16 @@ After returns all the items after the first N in a rangeable list.
## collections.Append {#collections_namespace_append}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Append appends the arguments up to the last one to the slice in the last argument.
-This construct allows template constructs like this:
-
-```go-html-template
-{{ $pages = $pages | append $p2 $p1 }}
-
-```
+Append appends the arguments up to the last one to the slice in the last argument.
+This construct allows template constructs like this:
+ {{ $pages = $pages | append $p2 $p1 }}
Note that with 2 arguments where both are slices of the same type,
the first slice will be appended to the second:
-
-
-```go-html-template
-{{ $pages = $pages | append .Site.RegularPages }}
-
-
-```
+ {{ $pages = $pages | append .Site.RegularPages }}
{{< docs/func-aliases "collections.Append" >}}
{{< docs/func-examples "collections.Append" >}}
@@ -78,11 +69,12 @@ the first slice will be appended to the second:
## collections.Apply {#collections_namespace_apply}
-\(,[any](/documentation/reference/gotypes/#any),[string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(seq [any](/documentation/reference/gotypes/#any), fname [string](/documentation/reference/gotypes/#string), args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Apply takes a map, array, or slice and returns a new slice with the function fname applied over it.
+Apply takes a map, array, or slice and returns a new slice with the function `fname` applied over it.
+
{{< docs/func-aliases "collections.Apply" >}}
{{< docs/func-examples "collections.Apply" >}}
@@ -94,20 +86,16 @@ Apply takes a map, array, or slice and returns a new slice with the function fna
## collections.Complement {#collections_namespace_complement}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(seqs [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Complement gives the elements in the last element of seqs that are not in
-any of the others.
-All elements of seqs must be slices or arrays of comparable types.
-
-The reasoning behind this rather clumsy API is so we can do this in the templates:
-```go-html-template
-{{ $c := .Pages | complement $last4 }}
-
+Complement gives the elements in the last element of `seqs` that are not in
+any of the others.
+All elements of `seqs` must be slices or arrays of comparable types.
-```
+The reasoning behind this rather clumsy API is so we can do this in the templates:
+ {{ $c := .Pages | complement $last4 }}
{{< docs/func-aliases "collections.Complement" >}}
{{< docs/func-examples "collections.Complement" >}}
@@ -120,12 +108,13 @@ The reasoning behind this rather clumsy API is so we can do this in the template
## collections.Delimit {#collections_namespace_delimit}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(seq [any](/documentation/reference/gotypes/#any), last [...any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Delimit takes a given sequence and returns a delimited HTML string.
-If last is passed to the function, it will be used as the final delimiter.
+Delimit takes a given sequence and returns a delimited HTML string.
+If `last` is passed to the function, it will be used as the final delimiter.
+
{{< docs/func-aliases "collections.Delimit" >}}
{{< docs/func-examples "collections.Delimit" >}}
@@ -137,14 +126,15 @@ If last is passed to the function, it will be used as the final delimiter.
## collections.Dictionary {#collections_namespace_dictionary}
-\([...any](/documentation/reference/objects//...any)\) → [map[string]any](/documentation/reference/objects//map[string]any)
+\(values [...any](/documentation/reference/gotypes/#any)\) → [map[string]any](/documentation/reference/gotypes/#mapstringany)
{.funcsig}
+
+
Dictionary creates a map[string]interface{} from the given parameters by
walking the parameters and treating them as key-value pairs. The number
of parameters must be even.
The keys can be string slices, which will create the needed nested structure.
-
{{< docs/func-aliases "collections.Dictionary" >}}
{{< docs/func-examples "collections.Dictionary" >}}
@@ -156,12 +146,13 @@ The keys can be string slices, which will create the needed nested structure.
## collections.EchoParam {#collections_namespace_echoparam}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-EchoParam returns a given value if it is set; otherwise, it returns an
-empty string.
+EchoParam returns `a` given value if it is set; otherwise, it returns an
+empty string.
+
{{< docs/func-aliases "collections.EchoParam" >}}
{{< docs/func-examples "collections.EchoParam" >}}
@@ -173,11 +164,12 @@ empty string.
## collections.First {#collections_namespace_first}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(limit [any](/documentation/reference/gotypes/#any), seq [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-First returns the first N items in a rangeable list.
+First returns the first N items in a rangeable list.
+
{{< docs/func-aliases "collections.First" >}}
{{< docs/func-examples "collections.First" >}}
@@ -189,12 +181,13 @@ First returns the first N items in a rangeable list.
## collections.Group {#collections_namespace_group}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(key [any](/documentation/reference/gotypes/#any), items [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Group groups a set of elements by the given key.
-This is currently only supported for [Pages](/documentation/reference/objects/resources/page/pages) .
+Group groups a set of elements by the given `key`.
+This is currently only supported for Pages.
+
{{< docs/func-aliases "collections.Group" >}}
{{< docs/func-examples "collections.Group" >}}
@@ -206,11 +199,12 @@ This is currently only supported for [Pages](/documentation/reference/objects/r
## collections.In {#collections_namespace_in}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(l [any](/documentation/reference/gotypes/#any), v [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-In returns whether v is in the set l. l may be an array or slice.
+In returns whether `v` is in the set `l`. `l` may be an array or slice.
+
{{< docs/func-aliases "collections.In" >}}
{{< docs/func-examples "collections.In" >}}
@@ -222,19 +216,20 @@ In returns whether v is in the set l. l may be an array or slice.
## collections.Index {#collections_namespace_index}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(item [any](/documentation/reference/gotypes/#any), args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
Index returns the result of indexing its first argument by the following
arguments. Thus "index x 1 2 3" is, in Go syntax, x[1][2][3]. Each
-indexed item must be a map, slice, or array.
+indexed `item` must be a map, slice, or array.
Copied from Go stdlib src/text/template/funcs.go.
-We deviate from the stdlib due to <a href="https://github.com/golang/go/issues/14751">https://github.com/golang/go/issues/14751</a>.
+We deviate from the stdlib due to https://github.com/golang/go/issues/14751.
TODO(moorereason): merge upstream changes.
-
{{< docs/func-aliases "collections.Index" >}}
{{< docs/func-examples "collections.Index" >}}
@@ -246,12 +241,13 @@ TODO(moorereason): merge upstream changes.
## collections.Intersect {#collections_namespace_intersect}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(l1 [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Intersect returns the common elements in the given sets, l1 and l2. l1 and
-l2 must be of the same type and may be either arrays or slices.
+Intersect returns the common elements in the given sets, `l1` and l2. `l1` and
+l2 must be of the same type and may be either arrays or slices.
+
{{< docs/func-aliases "collections.Intersect" >}}
{{< docs/func-examples "collections.Intersect" >}}
@@ -263,12 +259,13 @@ l2 must be of the same type and may be either arrays or slices.
## collections.IsSet {#collections_namespace_isset}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(a [any](/documentation/reference/gotypes/#any), key [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-IsSet returns whether a given array, channel, slice, or map has a key
-defined.
+IsSet returns whether `a` given array, channel, slice, or map has `a` `key`
+defined.
+
{{< docs/func-aliases "collections.IsSet" >}}
{{< docs/func-examples "collections.IsSet" >}}
@@ -280,11 +277,12 @@ defined.
## collections.KeyVals {#collections_namespace_keyvals}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [KeyValues](/documentation/reference/objects/common/types/keyvalues)
+\(key [any](/documentation/reference/gotypes/#any), vals [...any](/documentation/reference/gotypes/#any)\) → [KeyValues](/documentation/reference/objects/common/types/keyvalues)
{.funcsig}
-KeyVals creates a key and values wrapper.
+KeyVals creates a `key` and values wrapper.
+
{{< docs/func-aliases "collections.KeyVals" >}}
{{< docs/func-examples "collections.KeyVals" >}}
@@ -296,11 +294,12 @@ KeyVals creates a key and values wrapper.
## collections.Last {#collections_namespace_last}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(limit [any](/documentation/reference/gotypes/#any), seq [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Last returns the last N items in a rangeable list.
+Last returns the last N items in a rangeable list.
+
{{< docs/func-aliases "collections.Last" >}}
{{< docs/func-examples "collections.Last" >}}
@@ -312,13 +311,14 @@ Last returns the last N items in a rangeable list.
## collections.Merge {#collections_namespace_merge}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(params [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
Merge creates a copy of the final parameter and merges the preceding
parameters into it in reverse order.
Currently only maps are supported. Key handling is case insensitive.
-
{{< docs/func-aliases "collections.Merge" >}}
{{< docs/func-examples "collections.Merge" >}}
@@ -330,12 +330,13 @@ Currently only maps are supported. Key handling is case insensitive.
## collections.NewScratch {#collections_namespace_newscratch}
-\(\) → [*maps.Scratch](/documentation/reference/objects//*maps.scratch)
+\(\) → [maps.Scratch](/documentation/reference/objects//maps.scratch)
{.funcsig}
+
+
NewScratch creates a new Scratch which can be used to store values in a
thread safe way.
-
{{< docs/func-aliases "collections.NewScratch" >}}
{{< docs/func-examples "collections.NewScratch" >}}
@@ -347,11 +348,12 @@ thread safe way.
## collections.Querify {#collections_namespace_querify}
-\([...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(params [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Querify encodes the given parameters in URL-encoded form ("bar=baz&foo=quux") sorted by key.
+Querify encodes the given parameters in URL-encoded form ("bar=baz&foo=quux") sorted by key.
+
{{< docs/func-aliases "collections.Querify" >}}
{{< docs/func-examples "collections.Querify" >}}
@@ -363,11 +365,12 @@ Querify encodes the given parameters in URL-encoded form ("bar=baz&foo=quux") so
## collections.Reverse {#collections_namespace_reverse}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(slice [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Reverse creates a copy of slice and reverses it.
+Reverse creates a copy of `slice` and reverses it.
+
{{< docs/func-aliases "collections.Reverse" >}}
{{< docs/func-examples "collections.Reverse" >}}
@@ -379,26 +382,18 @@ Reverse creates a copy of slice and reverses it.
## collections.Seq {#collections_namespace_seq}
-\([...any](/documentation/reference/objects//...any)\) → [[]int](/documentation/reference/objects//[]int)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [[]int](/documentation/reference/gotypes/#int)
{.funcsig}
-Seq creates a sequence of integers. It's named and used as GNU's seq.
-
-Examples:
-
-```go-html-template
-3 => 1, 2, 3
-
-1 2 4 => 1, 3
-
--3 => -1, -2, -3
-
-1 4 => 1, 2, 3, 4
-
-1 -2 => 1, 0, -1, -2
+Seq creates a sequence of integers. It's named and used as GNU's seq.
-```
+Examples:
+ 3 => 1, 2, 3
+ 1 2 4 => 1, 3
+ -3 => -1, -2, -3
+ 1 4 => 1, 2, 3, 4
+ 1 -2 => 1, 0, -1, -2
{{< docs/func-aliases "collections.Seq" >}}
{{< docs/func-examples "collections.Seq" >}}
@@ -411,11 +406,12 @@ Examples:
## collections.Shuffle {#collections_namespace_shuffle}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(seq [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Shuffle returns the given rangeable list in a randomised order.
+Shuffle returns the given rangeable list in a randomised order.
+
{{< docs/func-aliases "collections.Shuffle" >}}
{{< docs/func-examples "collections.Shuffle" >}}
@@ -427,11 +423,12 @@ Shuffle returns the given rangeable list in a randomised order.
## collections.Slice {#collections_namespace_slice}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Slice returns a slice of all passed arguments.
+Slice returns a slice of all passed arguments.
+
{{< docs/func-aliases "collections.Slice" >}}
{{< docs/func-examples "collections.Slice" >}}
@@ -443,11 +440,12 @@ Slice returns a slice of all passed arguments.
## collections.Sort {#collections_namespace_sort}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(seq [any](/documentation/reference/gotypes/#any), args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Sort returns a sorted sequence.
+Sort returns a sorted sequence.
+
{{< docs/func-aliases "collections.Sort" >}}
{{< docs/func-examples "collections.Sort" >}}
@@ -459,12 +457,13 @@ Sort returns a sorted sequence.
## collections.SymDiff {#collections_namespace_symdiff}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(s2 [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-SymDiff returns the symmetric difference of s1 and s2.
-Arguments must be either a slice or an array of comparable types.
+SymDiff returns the symmetric difference of s1 and `s2`.
+Arguments must be either a slice or an array of comparable types.
+
{{< docs/func-aliases "collections.SymDiff" >}}
{{< docs/func-examples "collections.SymDiff" >}}
@@ -476,14 +475,15 @@ Arguments must be either a slice or an array of comparable types.
## collections.Union {#collections_namespace_union}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(l1 [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Union returns the union of the given sets, l1 and l2. l1 and
-l2 must be of the same type and may be either arrays or slices.
-If l1 and l2 aren't of the same type then l1 will be returned.
-If either l1 or l2 is nil then the non-nil list will be returned.
+Union returns the union of the given sets, `l1` and l2. `l1` and
+l2 must be of the same type and may be either arrays or slices.
+If `l1` and l2 aren't of the same type then `l1` will be returned.
+If either `l1` or l2 is nil then the non-nil list will be returned.
+
{{< docs/func-aliases "collections.Union" >}}
{{< docs/func-examples "collections.Union" >}}
@@ -495,12 +495,13 @@ If either l1 or l2 is nil then the non-nil list will be returned.
## collections.Uniq {#collections_namespace_uniq}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(seq [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
Uniq takes in a slice or array and returns a slice with subsequent
duplicate elements removed.
-
{{< docs/func-aliases "collections.Uniq" >}}
{{< docs/func-examples "collections.Uniq" >}}
@@ -512,11 +513,12 @@ duplicate elements removed.
## collections.Where {#collections_namespace_where}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(seq [any](/documentation/reference/gotypes/#any), args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Where returns a filtered subset of a given data type.
+Where returns a filtered subset of a given data type.
+
{{< docs/func-aliases "collections.Where" >}}
{{< docs/func-examples "collections.Where" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/compare/compare/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/compare/compare/index.md
index 5ee6e93..d151a7b 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/compare/compare/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/compare/compare/index.md
@@ -30,12 +30,13 @@ hugoSymbol: TODO
## compare.Conditional {#compare_namespace_conditional}
-\([bool](/documentation/reference/gotypes/#bool),[any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(condition [bool](/documentation/reference/gotypes/#bool), a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Conditional can be used as a ternary operator.
-It returns a if condition, else b.
+Conditional can be used as `a` ternary operator.
+It returns `a` if `condition`, else b.
+
{{< docs/func-aliases "compare.Conditional" >}}
{{< docs/func-examples "compare.Conditional" >}}
@@ -47,14 +48,15 @@ It returns a if condition, else b.
## compare.Default {#compare_namespace_default}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(dflt [any](/documentation/reference/gotypes/#any), given [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Default checks whether a given value is set and returns a default value if it
+
+
+Default checks whether a `given` value is set and returns a default value if it
is not. "Set" in this context means non-zero for numeric types and times;
non-zero length for strings, arrays, slices, and maps;
any boolean or struct value; or non-nil for any other types.
-
{{< docs/func-aliases "compare.Default" >}}
{{< docs/func-examples "compare.Default" >}}
@@ -66,11 +68,12 @@ any boolean or struct value; or non-nil for any other types.
## compare.Eq {#compare_namespace_eq}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Eq returns the boolean truth of arg1 == arg2 || arg1 == arg3 || arg1 == arg4.
+Eq returns the boolean truth of arg1 == arg2 || arg1 == arg3 || arg1 == arg4.
+
{{< docs/func-aliases "compare.Eq" >}}
{{< docs/func-examples "compare.Eq" >}}
@@ -82,11 +85,12 @@ Eq returns the boolean truth of arg1 == arg2 || arg1 == arg3 || arg1 == arg4.
## compare.Ge {#compare_namespace_ge}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Ge returns the boolean truth of arg1 >= arg2 && arg1 >= arg3 && arg1 >= arg4.
+Ge returns the boolean truth of arg1 >= arg2 && arg1 >= arg3 && arg1 >= arg4.
+
{{< docs/func-aliases "compare.Ge" >}}
{{< docs/func-examples "compare.Ge" >}}
@@ -98,11 +102,12 @@ Ge returns the boolean truth of arg1 >= arg2 && arg1 >= arg3 && arg1 >= arg4.
## compare.Gt {#compare_namespace_gt}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Gt returns the boolean truth of arg1 > arg2 && arg1 > arg3 && arg1 > arg4.
+Gt returns the boolean truth of arg1 > arg2 && arg1 > arg3 && arg1 > arg4.
+
{{< docs/func-aliases "compare.Gt" >}}
{{< docs/func-examples "compare.Gt" >}}
@@ -114,11 +119,12 @@ Gt returns the boolean truth of arg1 > arg2 && arg1 > arg3 && arg1 > arg4.
## compare.Le {#compare_namespace_le}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Le returns the boolean truth of arg1 <= arg2 && arg1 <= arg3 && arg1 <= arg4.
+Le returns the boolean truth of arg1 <= arg2 && arg1 <= arg3 && arg1 <= arg4.
+
{{< docs/func-aliases "compare.Le" >}}
{{< docs/func-examples "compare.Le" >}}
@@ -130,11 +136,12 @@ Le returns the boolean truth of arg1 <= arg2 && arg1 <= arg3 && arg1 <= arg4.
## compare.Lt {#compare_namespace_lt}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Lt returns the boolean truth of arg1 < arg2 && arg1 < arg3 && arg1 < arg4.
+Lt returns the boolean truth of arg1 < arg2 && arg1 < arg3 && arg1 < arg4.
+
{{< docs/func-aliases "compare.Lt" >}}
{{< docs/func-examples "compare.Lt" >}}
@@ -148,11 +155,12 @@ Lt returns the boolean truth of arg1 < arg2 && arg1 < arg3 && arg1 < arg4.
## compare.Ne {#compare_namespace_ne}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(first [any](/documentation/reference/gotypes/#any), others [...any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Ne returns the boolean truth of arg1 != arg2 && arg1 != arg3 && arg1 != arg4.
+Ne returns the boolean truth of arg1 != arg2 && arg1 != arg3 && arg1 != arg4.
+
{{< docs/func-aliases "compare.Ne" >}}
{{< docs/func-examples "compare.Ne" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/crypto/crypto/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/crypto/crypto/index.md
index 68734ef..e7b5af1 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/crypto/crypto/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/crypto/crypto/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## crypto.FNV32a {#crypto_namespace_fnv32a}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(in [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-FNV32a hashes using fnv32a algorithm
+FNV32a hashes using fnv32a algorithm
+
{{< docs/func-aliases "crypto.FNV32a" >}}
{{< docs/func-examples "crypto.FNV32a" >}}
@@ -46,11 +47,12 @@ FNV32a hashes using fnv32a algorithm
## crypto.HMAC {#crypto_namespace_hmac}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(h [any](/documentation/reference/gotypes/#any), k [any](/documentation/reference/gotypes/#any), m [any](/documentation/reference/gotypes/#any), e [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-HMAC returns a cryptographic hash that uses a key to sign a message.
+HMAC returns a cryptographic hash that uses a key to sign a message.
+
{{< docs/func-aliases "crypto.HMAC" >}}
{{< docs/func-examples "crypto.HMAC" >}}
@@ -62,11 +64,12 @@ HMAC returns a cryptographic hash that uses a key to sign a message.
## crypto.MD5 {#crypto_namespace_md5}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-MD5 hashes the given input and returns its MD5 checksum.
+MD5 hashes the given input and returns its MD5 checksum.
+
{{< docs/func-aliases "crypto.MD5" >}}
{{< docs/func-examples "crypto.MD5" >}}
@@ -78,11 +81,12 @@ MD5 hashes the given input and returns its MD5 checksum.
## crypto.SHA1 {#crypto_namespace_sha1}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-SHA1 hashes the given input and returns its SHA1 checksum.
+SHA1 hashes the given input and returns its SHA1 checksum.
+
{{< docs/func-aliases "crypto.SHA1" >}}
{{< docs/func-examples "crypto.SHA1" >}}
@@ -94,11 +98,12 @@ SHA1 hashes the given input and returns its SHA1 checksum.
## crypto.SHA256 {#crypto_namespace_sha256}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-SHA256 hashes the given input and returns its SHA256 checksum.
+SHA256 hashes the given input and returns its SHA256 checksum.
+
{{< docs/func-aliases "crypto.SHA256" >}}
{{< docs/func-examples "crypto.SHA256" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/data/data/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/data/data/index.md
index 07fe982..189f25b 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/data/data/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/data/data/index.md
@@ -30,15 +30,16 @@ hugoSymbol: TODO
## data.GetCSV {#data_namespace_getcsv}
-\([string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [[][]string](/documentation/reference/objects//[][]string)
+\(sep [string](/documentation/reference/gotypes/#string), args [...any](/documentation/reference/gotypes/#any)\) → [[]string](/documentation/reference/objects//[]string)
{.funcsig}
+
+
GetCSV expects a data separator and one or n-parts of a URL to a resource which
can either be a local or a remote one.
The data separator can be a comma, semi-colon, pipe, etc, but only one character.
If you provide multiple parts for the URL they will be joined together to the final URL.
GetCSV returns nil or a slice slice to use in a short code.
-
{{< docs/func-aliases "data.GetCSV" >}}
{{< docs/func-examples "data.GetCSV" >}}
@@ -50,13 +51,14 @@ GetCSV returns nil or a slice slice to use in a short code.
## data.GetJSON {#data_namespace_getjson}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
GetJSON expects one or n-parts of a URL to a resource which can either be a local or a remote one.
If you provide multiple parts they will be joined together to the final URL.
GetJSON returns nil or parsed JSON to use in a short code.
-
{{< docs/func-aliases "data.GetJSON" >}}
{{< docs/func-examples "data.GetJSON" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/debug/debug/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/debug/debug/index.md
index 70d07d1..45f58b2 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/debug/debug/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/debug/debug/index.md
@@ -30,16 +30,17 @@ hugoSymbol: TODO
## debug.Dump {#debug_namespace_dump}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(val [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Dump returns a object dump of val as a string.
+
+
+Dump returns a object dump of `val` as a string.
Note that not every value passed to Dump will print so nicely, but
we'll improve on that. We recommend using the "go" Chroma lexer to format the output
nicely.
Also note that the output from Dump may change from Hugo version to the next,
so don't depend on a specific output.
-
{{< docs/func-aliases "debug.Dump" >}}
{{< docs/func-examples "debug.Dump" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/encoding/encoding/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/encoding/encoding/index.md
index 84d1d27..f1f2a0b 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/encoding/encoding/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/encoding/encoding/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## encoding.Base64Decode {#encoding_namespace_base64decode}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(content [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Base64Decode returns the base64 decoding of the given content.
+Base64Decode returns the base64 decoding of the given `content`.
+
{{< docs/func-aliases "encoding.Base64Decode" >}}
{{< docs/func-examples "encoding.Base64Decode" >}}
@@ -46,11 +47,12 @@ Base64Decode returns the base64 decoding of the given content.
## encoding.Base64Encode {#encoding_namespace_base64encode}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(content [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Base64Encode returns the base64 encoding of the given content.
+Base64Encode returns the base64 encoding of the given `content`.
+
{{< docs/func-aliases "encoding.Base64Encode" >}}
{{< docs/func-examples "encoding.Base64Encode" >}}
@@ -62,15 +64,16 @@ Base64Encode returns the base64 encoding of the given content.
## encoding.Jsonify {#encoding_namespace_jsonify}
-\([...any](/documentation/reference/objects//...any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
+
+
Jsonify encodes a given object to JSON. To pretty print the JSON, pass a map
or dictionary of options as the first argument. Supported options are
"prefix" and "indent". Each JSON element in the output will begin on a new
line beginning with prefix followed by one or more copies of indent according
to the indentation nesting.
-
{{< docs/func-aliases "encoding.Jsonify" >}}
{{< docs/func-examples "encoding.Jsonify" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/fmt/fmt/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/fmt/fmt/index.md
index d27cf21..975bc54 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/fmt/fmt/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/fmt/fmt/index.md
@@ -30,12 +30,13 @@ hugoSymbol: TODO
## fmt.Errorf {#fmt_namespace_errorf}
-\([string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(format [string](/documentation/reference/gotypes/#string), a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Errorf formats according to a format specifier and logs an ERROR.
-It returns an empty string.
+Errorf formats according to `a` `format` specifier and logs an ERROR.
+It returns an empty string.
+
{{< docs/func-aliases "fmt.Errorf" >}}
{{< docs/func-examples "fmt.Errorf" >}}
@@ -47,13 +48,14 @@ It returns an empty string.
## fmt.Erroridf {#fmt_namespace_erroridf}
-\([string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(id [string](/documentation/reference/gotypes/#string), a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Erroridf formats according to a format specifier and logs an ERROR and
+
+
+Erroridf formats according to `a` format specifier and logs an ERROR and
an information text that the error with the given ID can be suppressed in config.
It returns an empty string.
-
{{< docs/func-aliases "fmt.Erroridf" >}}
{{< docs/func-examples "fmt.Erroridf" >}}
@@ -65,11 +67,12 @@ It returns an empty string.
## fmt.Print {#fmt_namespace_print}
-\([...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Print returns string representation of the passed arguments.
+Print returns string representation of the passed arguments.
+
{{< docs/func-aliases "fmt.Print" >}}
{{< docs/func-examples "fmt.Print" >}}
@@ -81,11 +84,12 @@ Print returns string representation of the passed arguments.
## fmt.Printf {#fmt_namespace_printf}
-\([string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(format [string](/documentation/reference/gotypes/#string), a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Printf returns a formatted string representation of the passed arguments.
+Printf returns `a` formatted string representation of the passed arguments.
+
{{< docs/func-aliases "fmt.Printf" >}}
{{< docs/func-examples "fmt.Printf" >}}
@@ -97,11 +101,12 @@ Printf returns a formatted string representation of the passed arguments.
## fmt.Println {#fmt_namespace_println}
-\([...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Println returns string representation of the passed arguments ending with a newline.
+Println returns string representation of the passed arguments ending with `a` newline.
+
{{< docs/func-aliases "fmt.Println" >}}
{{< docs/func-examples "fmt.Println" >}}
@@ -113,12 +118,13 @@ Println returns string representation of the passed arguments ending with a newl
## fmt.Warnf {#fmt_namespace_warnf}
-\([string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(format [string](/documentation/reference/gotypes/#string), a [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Warnf formats according to a format specifier and logs a WARNING.
-It returns an empty string.
+Warnf formats according to `a` `format` specifier and logs `a` WARNING.
+It returns an empty string.
+
{{< docs/func-aliases "fmt.Warnf" >}}
{{< docs/func-examples "fmt.Warnf" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/images/images/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/images/images/index.md
index 55de507..9af2a67 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/images/images/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/images/images/index.md
@@ -34,12 +34,13 @@ tags:
## images.Config {#images_namespace_config}
-\([any](/documentation/reference/gotypes/#any)\) → [Config](/documentation/reference/objects/image/config)
+\(path [any](/documentation/reference/gotypes/#any)\) → [Config](/documentation/reference/objects/image/config)
{.funcsig}
-Config returns the image.Config for the specified path relative to the
-working directory.
+Config returns the image.Config for the specified `path` relative to the
+working directory.
+
{{< docs/func-aliases "images.Config" >}}
{{< docs/func-examples "images.Config" >}}
@@ -51,9 +52,11 @@ working directory.
## images.Filter {#images_namespace_filter}
-\([...any](/documentation/reference/objects//...any)\) → [ImageResource](/documentation/reference/objects/resources/images/imageresource)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [ImageResource](/documentation/reference/objects/resources/images/imageresource)
{.funcsig}
+
+
{{< docs/func-aliases "images.Filter" >}}
{{< docs/func-examples "images.Filter" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/inflect/inflect/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/inflect/inflect/index.md
index 819fcf9..70902ad 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/inflect/inflect/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/inflect/inflect/index.md
@@ -30,23 +30,18 @@ hugoSymbol: TODO
## inflect.Humanize {#inflect_namespace_humanize}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Humanize returns the humanized form of a single parameter.
If the parameter is either an integer or a string containing an integer
value, the behavior is to add the appropriate ordinal.
-
-```go-html-template
-Example: "my-first-post" -> "My first post"
-
-Example: "103" -> "103rd"
-
-Example: 52 -> "52nd"
-
-
-```
+ Example: "my-first-post" -> "My first post"
+ Example: "103" -> "103rd"
+ Example: 52 -> "52nd"
{{< docs/func-aliases "inflect.Humanize" >}}
{{< docs/func-examples "inflect.Humanize" >}}
@@ -59,11 +54,12 @@ Example: 52 -> "52nd"
## inflect.Pluralize {#inflect_namespace_pluralize}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Pluralize returns the plural form of a single word.
+Pluralize returns the plural form of a single word.
+
{{< docs/func-aliases "inflect.Pluralize" >}}
{{< docs/func-examples "inflect.Pluralize" >}}
@@ -75,11 +71,12 @@ Pluralize returns the plural form of a single word.
## inflect.Singularize {#inflect_namespace_singularize}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(in [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Singularize returns the singular form of a single word.
+Singularize returns the singular form of a single word.
+
{{< docs/func-aliases "inflect.Singularize" >}}
{{< docs/func-examples "inflect.Singularize" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/js/js/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/js/js/index.md
index 7eee27e..4a5b7af 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/js/js/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/js/js/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## js.Build {#js_namespace_build}
-\([...any](/documentation/reference/objects//...any)\) → [Resource](/documentation/reference/objects/resources/resource/resource)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [Resource](/documentation/reference/objects/resources/resource/resource)
{.funcsig}
-Build processes the given Resource with ESBuild.
+Build processes the given Resource with ESBuild.
+
{{< docs/func-aliases "js.Build" >}}
{{< docs/func-examples "js.Build" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/lang/lang/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/lang/lang/index.md
index 58e2865..881ea5d 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/lang/lang/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/lang/lang/index.md
@@ -30,14 +30,15 @@ hugoSymbol: TODO
## lang.FormatAccounting {#lang_namespace_formataccounting}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(precision [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FormatAccounting returns the currency representation of number for the given currency and precision
+
+
+FormatAccounting returns the currency representation of number for the given currency and `precision`
for the current language in accounting notation.
The return value is formatted with at least two decimal places.
-
{{< docs/func-aliases "lang.FormatAccounting" >}}
{{< docs/func-examples "lang.FormatAccounting" >}}
@@ -49,14 +50,15 @@ The return value is formatted with at least two decimal places.
## lang.FormatCurrency {#lang_namespace_formatcurrency}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(precision [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FormatCurrency returns the currency representation of number for the given currency and precision
+
+
+FormatCurrency returns the currency representation of number for the given currency and `precision`
for the current language.
The return value is formatted with at least two decimal places.
-
{{< docs/func-aliases "lang.FormatCurrency" >}}
{{< docs/func-examples "lang.FormatCurrency" >}}
@@ -68,11 +70,12 @@ The return value is formatted with at least two decimal places.
## lang.FormatNumber {#lang_namespace_formatnumber}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(precision [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FormatNumber formats number with the given precision for the current language.
+FormatNumber formats number with the given `precision` for the current language.
+
{{< docs/func-aliases "lang.FormatNumber" >}}
{{< docs/func-examples "lang.FormatNumber" >}}
@@ -84,19 +87,20 @@ FormatNumber formats number with the given precision for the current language.
## lang.FormatNumberCustom {#lang_namespace_formatnumbercustom}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(precision [any](/documentation/reference/gotypes/#any), options [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FormatNumberCustom formats a number with the given precision using the
-negative, decimal, and grouping options. The `options`
+
+
+FormatNumberCustom formats a number with the given `precision` using the
+negative, decimal, and grouping `options`. The ``options``
parameter is a string consisting of `<negative> <decimal> <grouping>`. The
-default `options` value is `- . ,`.
+default ``options`` value is `- . ,`.
Note that numbers are rounded up at 5 or greater.
-So, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.
+So, with `precision` set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.
For a simpler function that adapts to the current language, see FormatNumber.
-
{{< docs/func-aliases "lang.FormatNumberCustom" >}}
{{< docs/func-examples "lang.FormatNumberCustom" >}}
@@ -108,12 +112,13 @@ For a simpler function that adapts to the current language, see FormatNumber.
## lang.FormatPercent {#lang_namespace_formatpercent}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(precision [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FormatPercent formats number with the given precision for the current language.
-Note that the number is assumed to be a percentage.
+FormatPercent formats number with the given `precision` for the current language.
+Note that the number is assumed to be a percentage.
+
{{< docs/func-aliases "lang.FormatPercent" >}}
{{< docs/func-examples "lang.FormatPercent" >}}
@@ -125,11 +130,12 @@ Note that the number is assumed to be a percentage.
## lang.Merge {#lang_namespace_merge}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(p2 [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Merge creates a union of pages from two languages.
+Merge creates a union of pages from two languages.
+
{{< docs/func-aliases "lang.Merge" >}}
{{< docs/func-examples "lang.Merge" >}}
@@ -143,11 +149,12 @@ Merge creates a union of pages from two languages.
## lang.Translate {#lang_namespace_translate}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(id [any](/documentation/reference/gotypes/#any), args [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Translate returns a translated string for id.
+Translate returns a translated string for `id`.
+
{{< docs/func-aliases "lang.Translate" >}}
{{< docs/func-examples "lang.Translate" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/math/math/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/math/math/index.md
index e58af44..5ed7ae4 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/math/math/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/math/math/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## math.Add {#math_namespace_add}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Add adds two numbers.
+Add adds two numbers.
+
{{< docs/func-aliases "math.Add" >}}
{{< docs/func-examples "math.Add" >}}
@@ -46,11 +47,12 @@ Add adds two numbers.
## math.Ceil {#math_namespace_ceil}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(x [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Ceil returns the least integer value greater than or equal to x.
+Ceil returns the least integer value greater than or equal to `x`.
+
{{< docs/func-aliases "math.Ceil" >}}
{{< docs/func-examples "math.Ceil" >}}
@@ -64,13 +66,14 @@ Ceil returns the least integer value greater than or equal to x.
\(\) → [uint64](/documentation/reference/gotypes/#uint64)
{.funcsig}
+
+
Counter increments and returns a global counter.
This was originally added to be used in tests where now.UnixNano did not
have the needed precision (especially on Windows).
Note that given the parallel nature of Hugo, you cannot use this to get sequences of numbers,
and the counter will reset on new builds.
-
{{< docs/func-aliases "math.Counter" >}}
{{< docs/func-examples "math.Counter" >}}
@@ -82,11 +85,12 @@ and the counter will reset on new builds.
## math.Div {#math_namespace_div}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Div divides two numbers.
+Div divides two numbers.
+
{{< docs/func-aliases "math.Div" >}}
{{< docs/func-examples "math.Div" >}}
@@ -98,11 +102,12 @@ Div divides two numbers.
## math.Floor {#math_namespace_floor}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(x [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Floor returns the greatest integer value less than or equal to x.
+Floor returns the greatest integer value less than or equal to `x`.
+
{{< docs/func-aliases "math.Floor" >}}
{{< docs/func-examples "math.Floor" >}}
@@ -114,11 +119,12 @@ Floor returns the greatest integer value less than or equal to x.
## math.Log {#math_namespace_log}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Log returns the natural logarithm of a number.
+Log returns the natural logarithm of `a` number.
+
{{< docs/func-aliases "math.Log" >}}
{{< docs/func-examples "math.Log" >}}
@@ -130,11 +136,12 @@ Log returns the natural logarithm of a number.
## math.Max {#math_namespace_max}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Max returns the greater of two numbers.
+Max returns the greater of two numbers.
+
{{< docs/func-aliases "math.Max" >}}
{{< docs/func-examples "math.Max" >}}
@@ -146,11 +153,12 @@ Max returns the greater of two numbers.
## math.Min {#math_namespace_min}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Min returns the smaller of two numbers.
+Min returns the smaller of two numbers.
+
{{< docs/func-aliases "math.Min" >}}
{{< docs/func-examples "math.Min" >}}
@@ -162,11 +170,12 @@ Min returns the smaller of two numbers.
## math.Mod {#math_namespace_mod}
-\([any](/documentation/reference/gotypes/#any)\) → [int64](/documentation/reference/gotypes/#int64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [int64](/documentation/reference/gotypes/#int64)
{.funcsig}
-Mod returns a % b.
+Mod returns `a` % b.
+
{{< docs/func-aliases "math.Mod" >}}
{{< docs/func-examples "math.Mod" >}}
@@ -178,11 +187,12 @@ Mod returns a % b.
## math.ModBool {#math_namespace_modbool}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(a [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-ModBool returns the boolean of a % b. If a % b == 0, return true.
+ModBool returns the boolean of `a` % b. If `a` % b == 0, return true.
+
{{< docs/func-aliases "math.ModBool" >}}
{{< docs/func-examples "math.ModBool" >}}
@@ -194,11 +204,12 @@ ModBool returns the boolean of a % b. If a % b == 0, return true.
## math.Mul {#math_namespace_mul}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Mul multiplies two numbers.
+Mul multiplies two numbers.
+
{{< docs/func-aliases "math.Mul" >}}
{{< docs/func-examples "math.Mul" >}}
@@ -210,11 +221,12 @@ Mul multiplies two numbers.
## math.Pow {#math_namespace_pow}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Pow returns a raised to the power of b.
+Pow returns `a` raised to the power of b.
+
{{< docs/func-aliases "math.Pow" >}}
{{< docs/func-examples "math.Pow" >}}
@@ -226,11 +238,12 @@ Pow returns a raised to the power of b.
## math.Round {#math_namespace_round}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(x [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Round returns the nearest integer, rounding half away from zero.
+Round returns the nearest integer, rounding half away from zero.
+
{{< docs/func-aliases "math.Round" >}}
{{< docs/func-examples "math.Round" >}}
@@ -242,11 +255,12 @@ Round returns the nearest integer, rounding half away from zero.
## math.Sqrt {#math_namespace_sqrt}
-\([any](/documentation/reference/gotypes/#any)\) → [float64](/documentation/reference/gotypes/#float64)
+\(a [any](/documentation/reference/gotypes/#any)\) → [float](/documentation/reference/gotypes/#float)
{.funcsig}
-Sqrt returns the square root of a number.
+Sqrt returns the square root of `a` number.
+
{{< docs/func-aliases "math.Sqrt" >}}
{{< docs/func-examples "math.Sqrt" >}}
@@ -258,11 +272,12 @@ Sqrt returns the square root of a number.
## math.Sub {#math_namespace_sub}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(a [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Sub subtracts two numbers.
+Sub subtracts two numbers.
+
{{< docs/func-aliases "math.Sub" >}}
{{< docs/func-examples "math.Sub" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/openapi/openapi3/openapi/openapi3/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/openapi/openapi3/openapi/openapi3/index.md
index 21440a5..fbc6a8f 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/openapi/openapi3/openapi/openapi3/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/openapi/openapi3/openapi/openapi3/index.md
@@ -30,9 +30,11 @@ hugoSymbol: TODO
## openapi3.Unmarshal {#openapi3_namespace_unmarshal}
-\([UnmarshableResource](/documentation/reference/objects/resources/resource/unmarshableresource)\) → [*kopenapi3.T](/documentation/reference/objects//*kopenapi3.t)
+\(r [Resource](/documentation/reference/objects/resources/resource/resource)\) → [kopenapi3.T](/documentation/reference/objects//kopenapi3.t)
{.funcsig}
+
+
{{< docs/func-aliases "openapi3.Unmarshal" >}}
{{< docs/func-examples "openapi3.Unmarshal" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/os/os/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/os/os/index.md
index 679774f..9e27eb1 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/os/os/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/os/os/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## os.FileExists {#os_namespace_fileexists}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(i [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-FileExists checks whether a file exists under the given path.
+FileExists checks whether a file exists under the given path.
+
{{< docs/func-aliases "os.FileExists" >}}
{{< docs/func-examples "os.FileExists" >}}
@@ -46,12 +47,13 @@ FileExists checks whether a file exists under the given path.
## os.Getenv {#os_namespace_getenv}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(key [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Getenv retrieves the value of the environment variable named by the key.
-It returns the value, which will be empty if the variable is not present.
+Getenv retrieves the value of the environment variable named by the `key`.
+It returns the value, which will be empty if the variable is not present.
+
{{< docs/func-aliases "os.Getenv" >}}
{{< docs/func-examples "os.Getenv" >}}
@@ -63,11 +65,12 @@ It returns the value, which will be empty if the variable is not present.
## os.ReadDir {#os_namespace_readdir}
-\([any](/documentation/reference/gotypes/#any)\) → [[]_os.FileInfo](/documentation/reference/objects//[]_os.fileinfo)
+\(i [any](/documentation/reference/gotypes/#any)\) → [_os.FileInfo](/documentation/reference/objects//_os.fileinfo)
{.funcsig}
-ReadDir lists the directory contents relative to the configured WorkingDir.
+ReadDir lists the directory contents relative to the configured WorkingDir.
+
{{< docs/func-aliases "os.ReadDir" >}}
{{< docs/func-examples "os.ReadDir" >}}
@@ -79,13 +82,14 @@ ReadDir lists the directory contents relative to the configured WorkingDir.
## os.ReadFile {#os_namespace_readfile}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(i [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
ReadFile reads the file named by filename relative to the configured WorkingDir.
It returns the contents as a string.
There is an upper size limit set at 1 megabytes.
-
{{< docs/func-aliases "os.ReadFile" >}}
{{< docs/func-examples "os.ReadFile" >}}
@@ -97,11 +101,12 @@ There is an upper size limit set at 1 megabytes.
## os.Stat {#os_namespace_stat}
-\([any](/documentation/reference/gotypes/#any)\) → [FileInfo](/documentation/reference/objects/os/fileinfo)
+\(i [any](/documentation/reference/gotypes/#any)\) → [FileInfo](/documentation/reference/objects/os/fileinfo)
{.funcsig}
-Stat returns the os.FileInfo structure describing file.
+Stat returns the os.FileInfo structure describing file.
+
{{< docs/func-aliases "os.Stat" >}}
{{< docs/func-examples "os.Stat" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/partials/partials/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/partials/partials/index.md
index 5039a94..69d97e5 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/partials/partials/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/partials/partials/index.md
@@ -30,15 +30,16 @@ hugoSymbol: TODO
## partials.Include {#partials_namespace_include}
-\(,[string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(name [string](/documentation/reference/gotypes/#string), contextList [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
Include executes the named partial.
If the partial contains a return statement, that value will be returned.
Else, the rendered output will be returned:
A string if the partial is a text/template, or template.HTML when html/template.
Note that ctx is provided by Hugo, not the end user.
-
{{< docs/func-aliases "partials.Include" >}}
{{< docs/func-examples "partials.Include" >}}
@@ -50,12 +51,13 @@ Note that ctx is provided by Hugo, not the end user.
## partials.IncludeCached {#partials_namespace_includecached}
-\(,[string](/documentation/reference/gotypes/#string),[any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(name [string](/documentation/reference/gotypes/#string), context [any](/documentation/reference/gotypes/#any), variants [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-IncludeCached executes and caches partial templates. The cache is created with name+variants as the key.
-Note that ctx is provided by Hugo, not the end user.
+IncludeCached executes and caches partial templates. The cache is created with `name`+`variants` as the key.
+Note that ctx is provided by Hugo, not the end user.
+
{{< docs/func-aliases "partials.IncludeCached" >}}
{{< docs/func-examples "partials.IncludeCached" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/path/path/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/path/path/index.md
index d11a905..047e633 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/path/path/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/path/path/index.md
@@ -30,16 +30,17 @@ hugoSymbol: TODO
## path.Base {#path_namespace_base}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(path [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Base returns the last element of path.
+
+
+Base returns the last element of `path`.
Trailing slashes are removed before extracting the last element.
-If the path is empty, Base returns ".".
-If the path consists entirely of slashes, Base returns "/".
-The input path is passed into filepath.ToSlash converting any Windows slashes
+If the `path` is empty, Base returns ".".
+If the `path` consists entirely of slashes, Base returns "/".
+The input `path` is passed into filepath.ToSlash converting any Windows slashes
to forward slashes.
-
{{< docs/func-aliases "path.Base" >}}
{{< docs/func-examples "path.Base" >}}
@@ -51,12 +52,13 @@ to forward slashes.
## path.Clean {#path_namespace_clean}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(path [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Clean replaces the separators used with standard slashes and then
extraneous slashes are removed.
-
{{< docs/func-aliases "path.Clean" >}}
{{< docs/func-examples "path.Clean" >}}
@@ -68,19 +70,20 @@ extraneous slashes are removed.
## path.Dir {#path_namespace_dir}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(path [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Dir returns all but the last element of path, typically the path's directory.
-After dropping the final element using Split, the path is Cleaned and trailing
+
+
+Dir returns all but the last element of `path`, typically the `path`'s directory.
+After dropping the final element using Split, the `path` is Cleaned and trailing
slashes are removed.
-If the path is empty, Dir returns ".".
-If the path consists entirely of slashes followed by non-slash bytes, Dir
-returns a single slash. In any other case, the returned path does not end in a
+If the `path` is empty, Dir returns ".".
+If the `path` consists entirely of slashes followed by non-slash bytes, Dir
+returns a single slash. In any other case, the returned `path` does not end in a
slash.
-The input path is passed into filepath.ToSlash converting any Windows slashes
+The input `path` is passed into filepath.ToSlash converting any Windows slashes
to forward slashes.
-
{{< docs/func-aliases "path.Dir" >}}
{{< docs/func-examples "path.Dir" >}}
@@ -92,16 +95,17 @@ to forward slashes.
## path.Ext {#path_namespace_ext}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(path [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Ext returns the file name extension used by path.
+
+
+Ext returns the file name extension used by `path`.
The extension is the suffix beginning at the final dot
-in the final slash-separated element of path;
+in the final slash-separated element of `path`;
it is empty if there is no dot.
-The input path is passed into filepath.ToSlash converting any Windows slashes
+The input `path` is passed into filepath.ToSlash converting any Windows slashes
to forward slashes.
-
{{< docs/func-aliases "path.Ext" >}}
{{< docs/func-examples "path.Ext" >}}
@@ -113,16 +117,17 @@ to forward slashes.
## path.Join {#path_namespace_join}
-\([...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(elements [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Join joins any number of path elements into a single path, adding a
+
+
+Join joins any number of path `elements` into a single path, adding a
separating slash if necessary. All the input
-path elements are passed into filepath.ToSlash converting any Windows slashes
+path `elements` are passed into filepath.ToSlash converting any Windows slashes
to forward slashes.
The result is Cleaned; in particular,
all empty strings are ignored.
-
{{< docs/func-aliases "path.Join" >}}
{{< docs/func-examples "path.Join" >}}
@@ -134,16 +139,17 @@ all empty strings are ignored.
## path.Split {#path_namespace_split}
-\([any](/documentation/reference/gotypes/#any)\) → [DirFile](/documentation/reference/objects//dirfile)
+\(path [any](/documentation/reference/gotypes/#any)\) → [DirFile](/documentation/reference/objects//dirfile)
{.funcsig}
-Split splits path immediately following the final slash,
+
+
+Split splits `path` immediately following the final slash,
separating it into a directory and file name component.
-If there is no slash in path, Split returns an empty dir and
-file set to path.
-The input path is passed into filepath.ToSlash converting any Windows slashes
+If there is no slash in `path`, Split returns an empty dir and
+file set to `path`.
+The input `path` is passed into filepath.ToSlash converting any Windows slashes
to forward slashes.
-The returned values have the property that path = dir+file.
-
+The returned values have the property that `path` = dir+file.
{{< docs/func-aliases "path.Split" >}}
{{< docs/func-examples "path.Split" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/reflect/reflect/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/reflect/reflect/index.md
index 798a3a1..fe65f78 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/reflect/reflect/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/reflect/reflect/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## reflect.IsMap {#reflect_namespace_ismap}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(v [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-IsMap reports whether v is a map.
+IsMap reports whether `v` is a map.
+
{{< docs/func-aliases "reflect.IsMap" >}}
{{< docs/func-examples "reflect.IsMap" >}}
@@ -46,11 +47,12 @@ IsMap reports whether v is a map.
## reflect.IsSlice {#reflect_namespace_isslice}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(v [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-IsSlice reports whether v is a slice.
+IsSlice reports whether `v` is a slice.
+
{{< docs/func-aliases "reflect.IsSlice" >}}
{{< docs/func-examples "reflect.IsSlice" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/safe/safe/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/safe/safe/index.md
index 521d90d..dc208d4 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/safe/safe/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/safe/safe/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## safe.CSS {#safe_namespace_css}
-\([any](/documentation/reference/gotypes/#any)\) → [CSS](/documentation/reference/objects/html/template/css)
+\(a [any](/documentation/reference/gotypes/#any)\) → [CSS](/documentation/reference/objects/html/template/css)
{.funcsig}
-CSS returns a given string as html/template CSS content.
+CSS returns `a` given string as html/template CSS content.
+
{{< docs/func-aliases "safe.CSS" >}}
{{< docs/func-examples "safe.CSS" >}}
@@ -46,11 +47,12 @@ CSS returns a given string as html/template CSS content.
## safe.HTML {#safe_namespace_html}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-HTML returns a given string as html/template HTML content.
+HTML returns `a` given string as html/template HTML content.
+
{{< docs/func-aliases "safe.HTML" >}}
{{< docs/func-examples "safe.HTML" >}}
@@ -62,11 +64,12 @@ HTML returns a given string as html/template HTML content.
## safe.HTMLAttr {#safe_namespace_htmlattr}
-\([any](/documentation/reference/gotypes/#any)\) → [HTMLAttr](/documentation/reference/objects/html/template/htmlattr)
+\(a [any](/documentation/reference/gotypes/#any)\) → [HTMLAttr](/documentation/reference/objects/html/template/htmlattr)
{.funcsig}
-HTMLAttr returns a given string as html/template HTMLAttr content.
+HTMLAttr returns `a` given string as html/template HTMLAttr content.
+
{{< docs/func-aliases "safe.HTMLAttr" >}}
{{< docs/func-examples "safe.HTMLAttr" >}}
@@ -78,11 +81,12 @@ HTMLAttr returns a given string as html/template HTMLAttr content.
## safe.JS {#safe_namespace_js}
-\([any](/documentation/reference/gotypes/#any)\) → [JS](/documentation/reference/objects/html/template/js)
+\(a [any](/documentation/reference/gotypes/#any)\) → [JS](/documentation/reference/objects/html/template/js)
{.funcsig}
-JS returns the given string as a html/template JS content.
+JS returns the given string as `a` html/template JS content.
+
{{< docs/func-aliases "safe.JS" >}}
{{< docs/func-examples "safe.JS" >}}
@@ -94,11 +98,12 @@ JS returns the given string as a html/template JS content.
## safe.JSStr {#safe_namespace_jsstr}
-\([any](/documentation/reference/gotypes/#any)\) → [JSStr](/documentation/reference/objects/html/template/jsstr)
+\(a [any](/documentation/reference/gotypes/#any)\) → [JSStr](/documentation/reference/objects/html/template/jsstr)
{.funcsig}
-JSStr returns the given string as a html/template JSStr content.
+JSStr returns the given string as `a` html/template JSStr content.
+
{{< docs/func-aliases "safe.JSStr" >}}
{{< docs/func-examples "safe.JSStr" >}}
@@ -110,11 +115,12 @@ JSStr returns the given string as a html/template JSStr content.
## safe.SanitizeURL {#safe_namespace_sanitizeurl}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-SanitizeURL returns a given string as html/template URL content.
+SanitizeURL returns `a` given string as html/template URL content.
+
{{< docs/func-aliases "safe.SanitizeURL" >}}
{{< docs/func-examples "safe.SanitizeURL" >}}
@@ -126,11 +132,12 @@ SanitizeURL returns a given string as html/template URL content.
## safe.URL {#safe_namespace_url}
-\([any](/documentation/reference/gotypes/#any)\) → [URL](/documentation/reference/objects/html/template/url)
+\(a [any](/documentation/reference/gotypes/#any)\) → [URL](/documentation/reference/objects/html/template/url)
{.funcsig}
-URL returns a given string as html/template URL content.
+URL returns `a` given string as html/template URL content.
+
{{< docs/func-aliases "safe.URL" >}}
{{< docs/func-examples "safe.URL" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/strings/strings/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/strings/strings/index.md
index 1b797dd..64df192 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/strings/strings/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/strings/strings/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## strings.Chomp {#strings_namespace_chomp}
-\([any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
+\(s [any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
-Chomp returns a copy of s with all trailing newline characters removed.
+Chomp returns a copy of `s` with all trailing newline characters removed.
+
{{< docs/func-aliases "strings.Chomp" >}}
{{< docs/func-examples "strings.Chomp" >}}
@@ -46,11 +47,12 @@ Chomp returns a copy of s with all trailing newline characters removed.
## strings.Contains {#strings_namespace_contains}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(s [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Contains reports whether substr is in s.
+Contains reports whether substr is in `s`.
+
{{< docs/func-aliases "strings.Contains" >}}
{{< docs/func-examples "strings.Contains" >}}
@@ -62,11 +64,12 @@ Contains reports whether substr is in s.
## strings.ContainsAny {#strings_namespace_containsany}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(s [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-ContainsAny reports whether any Unicode code points in chars are within s.
+ContainsAny reports whether any Unicode code points in chars are within `s`.
+
{{< docs/func-aliases "strings.ContainsAny" >}}
{{< docs/func-examples "strings.ContainsAny" >}}
@@ -78,12 +81,13 @@ ContainsAny reports whether any Unicode code points in chars are within s.
## strings.Count {#strings_namespace_count}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(substr [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-Count counts the number of non-overlapping instances of substr in s.
-If substr is an empty string, Count returns 1 + the number of Unicode code points in s.
+Count counts the number of non-overlapping instances of `substr` in s.
+If `substr` is an empty string, Count returns 1 + the number of Unicode code points in s.
+
{{< docs/func-aliases "strings.Count" >}}
{{< docs/func-examples "strings.Count" >}}
@@ -95,11 +99,12 @@ If substr is an empty string, Count returns 1 + the number of Unicode code point
## strings.CountRunes {#strings_namespace_countrunes}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(s [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-CountRunes returns the number of runes in s, excluding whitespace.
+CountRunes returns the number of runes in `s`, excluding whitespace.
+
{{< docs/func-aliases "strings.CountRunes" >}}
{{< docs/func-examples "strings.CountRunes" >}}
@@ -111,11 +116,12 @@ CountRunes returns the number of runes in s, excluding whitespace.
## strings.CountWords {#strings_namespace_countwords}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(s [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-CountWords returns the approximate word count in s.
+CountWords returns the approximate word count in `s`.
+
{{< docs/func-aliases "strings.CountWords" >}}
{{< docs/func-examples "strings.CountWords" >}}
@@ -127,12 +133,13 @@ CountWords returns the approximate word count in s.
## strings.FindRE {#strings_namespace_findre}
-\([string](/documentation/reference/gotypes/#string),[any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [[]string](/documentation/reference/objects//[]string)
+\(expr [string](/documentation/reference/gotypes/#string), content [any](/documentation/reference/gotypes/#any), limit [...any](/documentation/reference/gotypes/#any)\) → [[]string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
FindRE returns a list of strings that match the regular expression. By default all matches
will be included. The number of matches can be limited with an optional third parameter.
-
{{< docs/func-aliases "strings.FindRE" >}}
{{< docs/func-examples "strings.FindRE" >}}
@@ -144,11 +151,12 @@ will be included. The number of matches can be limited with an optional third pa
## strings.FirstUpper {#strings_namespace_firstupper}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-FirstUpper returns a string with the first character as upper case.
+FirstUpper returns a string with the first character as upper case.
+
{{< docs/func-aliases "strings.FirstUpper" >}}
{{< docs/func-examples "strings.FirstUpper" >}}
@@ -160,11 +168,12 @@ FirstUpper returns a string with the first character as upper case.
## strings.HasPrefix {#strings_namespace_hasprefix}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(s [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-HasPrefix tests whether the input s begins with prefix.
+HasPrefix tests whether the input `s` begins with prefix.
+
{{< docs/func-aliases "strings.HasPrefix" >}}
{{< docs/func-examples "strings.HasPrefix" >}}
@@ -176,11 +185,12 @@ HasPrefix tests whether the input s begins with prefix.
## strings.HasSuffix {#strings_namespace_hassuffix}
-\([any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
+\(s [any](/documentation/reference/gotypes/#any)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-HasSuffix tests whether the input s begins with suffix.
+HasSuffix tests whether the input `s` begins with suffix.
+
{{< docs/func-aliases "strings.HasSuffix" >}}
{{< docs/func-examples "strings.HasSuffix" >}}
@@ -192,11 +202,12 @@ HasSuffix tests whether the input s begins with suffix.
## strings.Repeat {#strings_namespace_repeat}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(n [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Repeat returns a new string consisting of count copies of the string s.
+Repeat returns a new string consisting of count copies of the string s.
+
{{< docs/func-aliases "strings.Repeat" >}}
{{< docs/func-examples "strings.Repeat" >}}
@@ -208,13 +219,14 @@ Repeat returns a new string consisting of count copies of the string s.
## strings.Replace {#strings_namespace_replace}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any), limit [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Replace returns a copy of the string s with all occurrences of old replaced
+
+
+Replace returns a copy of the string `s` with all occurrences of old replaced
with new. The number of replacements can be limited with an optional fourth
parameter.
-
{{< docs/func-aliases "strings.Replace" >}}
{{< docs/func-examples "strings.Replace" >}}
@@ -226,13 +238,14 @@ parameter.
## strings.ReplaceRE {#strings_namespace_replacere}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(pattern [any](/documentation/reference/gotypes/#any), n [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
ReplaceRE returns a copy of s, replacing all matches of the regular
-expression pattern with the replacement text repl. The number of replacements
+expression `pattern` with the replacement text repl. The number of replacements
can be limited with an optional fourth parameter.
-
{{< docs/func-aliases "strings.ReplaceRE" >}}
{{< docs/func-examples "strings.ReplaceRE" >}}
@@ -244,11 +257,12 @@ can be limited with an optional fourth parameter.
## strings.RuneCount {#strings_namespace_runecount}
-\([any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
+\(s [any](/documentation/reference/gotypes/#any)\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
-RuneCount returns the number of runes in s.
+RuneCount returns the number of runes in `s`.
+
{{< docs/func-aliases "strings.RuneCount" >}}
{{< docs/func-examples "strings.RuneCount" >}}
@@ -260,13 +274,14 @@ RuneCount returns the number of runes in s.
## strings.SliceString {#strings_namespace_slicestring}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [any](/documentation/reference/gotypes/#any), startEnd [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-SliceString slices a string by specifying a half-open range with
-two indices, start and end. 1 and 4 creates a slice including elements 1 through 3.
-The end index can be omitted, it defaults to the string's length.
+SliceString slices `a` string by specifying `a` half-open range with
+two indices, start and end. 1 and 4 creates `a` slice including elements 1 through 3.
+The end index can be omitted, it defaults to the string's length.
+
{{< docs/func-aliases "strings.SliceString" >}}
{{< docs/func-examples "strings.SliceString" >}}
@@ -278,11 +293,12 @@ The end index can be omitted, it defaults to the string's length.
## strings.Split {#strings_namespace_split}
-\([any](/documentation/reference/gotypes/#any),[string](/documentation/reference/gotypes/#string)\) → [[]string](/documentation/reference/objects//[]string)
+\(a [any](/documentation/reference/gotypes/#any), delimiter [string](/documentation/reference/gotypes/#string)\) → [[]string](/documentation/reference/gotypes/#string)
{.funcsig}
-Split slices an input string into all substrings separated by delimiter.
+Split slices an input string into all substrings separated by `delimiter`.
+
{{< docs/func-aliases "strings.Split" >}}
{{< docs/func-examples "strings.Split" >}}
@@ -294,22 +310,23 @@ Split slices an input string into all substrings separated by delimiter.
## strings.Substr {#strings_namespace_substr}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [any](/documentation/reference/gotypes/#any), nums [...any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Substr extracts parts of a string, beginning at the character at the specified
+
+
+Substr extracts parts of `a` string, beginning at the character at the specified
position, and returns the specified number of characters.
It normally takes two parameters: start and length.
It can also take one parameter: start, i.e. length is omitted, in which case
the substring starting from start until the end of the string will be returned.
-To extract characters from the end of the string, use a negative start number.
+To extract characters from the end of the string, use `a` negative start number.
-In addition, borrowing from the extended behavior described at <a href="http://php.net/substr">http://php.net/substr</a>,
+In addition, borrowing from the extended behavior described at http://php.net/substr,
if length is given and is negative, then that many characters will be omitted from
the end of string.
-
{{< docs/func-aliases "strings.Substr" >}}
{{< docs/func-examples "strings.Substr" >}}
@@ -321,12 +338,13 @@ the end of string.
## strings.Title {#strings_namespace_title}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Title returns a copy of the input s with all Unicode letters that begin words
-mapped to their title case.
+Title returns a copy of the input `s` with all Unicode letters that begin words
+mapped to their title case.
+
{{< docs/func-aliases "strings.Title" >}}
{{< docs/func-examples "strings.Title" >}}
@@ -338,12 +356,13 @@ mapped to their title case.
## strings.ToLower {#strings_namespace_tolower}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-ToLower returns a copy of the input s with all Unicode letters mapped to their
-lower case.
+ToLower returns a copy of the input `s` with all Unicode letters mapped to their
+lower case.
+
{{< docs/func-aliases "strings.ToLower" >}}
{{< docs/func-examples "strings.ToLower" >}}
@@ -355,12 +374,13 @@ lower case.
## strings.ToUpper {#strings_namespace_toupper}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-ToUpper returns a copy of the input s with all Unicode letters mapped to their
-upper case.
+ToUpper returns a copy of the input `s` with all Unicode letters mapped to their
+upper case.
+
{{< docs/func-aliases "strings.ToUpper" >}}
{{< docs/func-examples "strings.ToUpper" >}}
@@ -372,12 +392,13 @@ upper case.
## strings.Trim {#strings_namespace_trim}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Trim returns a string with all leading and trailing characters defined
contained in cutset removed.
-
{{< docs/func-aliases "strings.Trim" >}}
{{< docs/func-examples "strings.Trim" >}}
@@ -389,12 +410,13 @@ contained in cutset removed.
## strings.TrimLeft {#strings_namespace_trimleft}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(cutset [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-TrimLeft returns a slice of the string s with all leading characters
-contained in cutset removed.
+TrimLeft returns a slice of the string s with all leading characters
+contained in `cutset` removed.
+
{{< docs/func-aliases "strings.TrimLeft" >}}
{{< docs/func-examples "strings.TrimLeft" >}}
@@ -406,12 +428,13 @@ contained in cutset removed.
## strings.TrimPrefix {#strings_namespace_trimprefix}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(prefix [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-TrimPrefix returns s without the provided leading prefix string. If s doesn't
-start with prefix, s is returned unchanged.
+TrimPrefix returns s without the provided leading `prefix` string. If s doesn't
+start with `prefix`, s is returned unchanged.
+
{{< docs/func-aliases "strings.TrimPrefix" >}}
{{< docs/func-examples "strings.TrimPrefix" >}}
@@ -423,12 +446,13 @@ start with prefix, s is returned unchanged.
## strings.TrimRight {#strings_namespace_trimright}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(cutset [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-TrimRight returns a slice of the string s with all trailing characters
-contained in cutset removed.
+TrimRight returns a slice of the string s with all trailing characters
+contained in `cutset` removed.
+
{{< docs/func-aliases "strings.TrimRight" >}}
{{< docs/func-examples "strings.TrimRight" >}}
@@ -440,12 +464,13 @@ contained in cutset removed.
## strings.TrimSuffix {#strings_namespace_trimsuffix}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(suffix [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-TrimSuffix returns s without the provided trailing suffix string. If s
-doesn't end with suffix, s is returned unchanged.
+TrimSuffix returns s without the provided trailing `suffix` string. If s
+doesn't end with `suffix`, s is returned unchanged.
+
{{< docs/func-aliases "strings.TrimSuffix" >}}
{{< docs/func-examples "strings.TrimSuffix" >}}
@@ -457,11 +482,12 @@ doesn't end with suffix, s is returned unchanged.
## strings.Truncate {#strings_namespace_truncate}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any), options [...any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Truncate truncates a given string to the specified length.
+Truncate truncates `a` given string to the specified length.
+
{{< docs/func-aliases "strings.Truncate" >}}
{{< docs/func-examples "strings.Truncate" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/templates/templates/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/templates/templates/index.md
index 6f21ed8..e2ef743 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/templates/templates/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/templates/templates/index.md
@@ -30,13 +30,14 @@ hugoSymbol: TODO
## templates.Exists {#templates_namespace_exists}
-\([string](/documentation/reference/gotypes/#string)\) → [bool](/documentation/reference/gotypes/#bool)
+\(name [string](/documentation/reference/gotypes/#string)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-Exists returns whether the template with the given name exists.
+
+
+Exists returns whether the template with the given `name` exists.
Note that this is the Unix-styled relative path including filename suffix,
e.g. partials/header.html
-
{{< docs/func-aliases "templates.Exists" >}}
{{< docs/func-examples "templates.Exists" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/time/time/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/time/time/index.md
index df66b1f..b19d982 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/time/time/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/time/time/index.md
@@ -30,12 +30,13 @@ hugoSymbol: TODO
## time.AsTime {#time_namespace_astime}
-\([any](/documentation/reference/gotypes/#any),[...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(v [any](/documentation/reference/gotypes/#any), args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
AsTime converts the textual representation of the datetime string into
a time.Time interface.
-
{{< docs/func-aliases "time.AsTime" >}}
{{< docs/func-examples "time.AsTime" >}}
@@ -47,12 +48,13 @@ a time.Time interface.
## time.Duration {#time_namespace_duration}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [Duration](/documentation/reference/objects/time/duration)
+\(unit [any](/documentation/reference/gotypes/#any), number [any](/documentation/reference/gotypes/#any)\) → [Duration](/documentation/reference/objects/time/duration)
{.funcsig}
-Duration converts the given number to a time.Duration.
-Unit is one of nanosecond/ns, microsecond/us/µs, millisecond/ms, second/s, minute/m or hour/h.
+Duration converts the given `number` to a time.Duration.
+Unit is one of nanosecond/ns, microsecond/us/µs, millisecond/ms, second/s, minute/m or hour/h.
+
{{< docs/func-aliases "time.Duration" >}}
{{< docs/func-examples "time.Duration" >}}
@@ -64,12 +66,13 @@ Unit is one of nanosecond/ns, microsecond/us/µs, millisecond/ms, second/s, minu
## time.Format {#time_namespace_format}
-\([string](/documentation/reference/gotypes/#string),[any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(layout [string](/documentation/reference/gotypes/#string), v [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Format converts the textual representation of the datetime string into
the other form or returns it of the time.Time value. These are formatted
-with the layout string
-
+with the `layout` string
{{< docs/func-aliases "time.Format" >}}
{{< docs/func-examples "time.Format" >}}
@@ -84,9 +87,10 @@ with the layout string
\(\) → [time.Time](/documentation/reference/gotypes/#timetime)
{.funcsig}
-Now returns the current local time.
+Now returns the current local time.
+
{{< docs/func-aliases "time.Now" >}}
{{< docs/func-examples "time.Now" >}}
@@ -98,15 +102,16 @@ Now returns the current local time.
## time.ParseDuration {#time_namespace_parseduration}
-\([any](/documentation/reference/gotypes/#any)\) → [Duration](/documentation/reference/objects/time/duration)
+\(in [any](/documentation/reference/gotypes/#any)\) → [Duration](/documentation/reference/objects/time/duration)
{.funcsig}
+
+
ParseDuration parses a duration string.
A duration string is a possibly signed sequence of
decimal numbers, each with optional fraction and a unit suffix,
such as "300ms", "-1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
-See <a href="https://golang.org/pkg/time/#ParseDuration">https://golang.org/pkg/time/#ParseDuration</a>
-
+See https://golang.org/pkg/time/#ParseDuration
{{< docs/func-aliases "time.ParseDuration" >}}
{{< docs/func-examples "time.ParseDuration" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/transform/transform/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/transform/transform/index.md
index c6517d1..9e697de 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/transform/transform/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/transform/transform/index.md
@@ -30,11 +30,12 @@ hugoSymbol: TODO
## transform.CanHighlight {#transform_namespace_canhighlight}
-\([string](/documentation/reference/gotypes/#string)\) → [bool](/documentation/reference/gotypes/#bool)
+\(lang [string](/documentation/reference/gotypes/#string)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-CanHighlight returns whether the given language is supported by the Chroma highlighter.
+CanHighlight returns whether the given language is supported by the Chroma highlighter.
+
{{< docs/func-aliases "transform.CanHighlight" >}}
{{< docs/func-examples "transform.CanHighlight" >}}
@@ -46,12 +47,13 @@ CanHighlight returns whether the given language is supported by the Chroma highl
## transform.Emojify {#transform_namespace_emojify}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(s [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Emojify returns a copy of s with all emoji codes replaced with actual emojis.
-See <a href="http://www.emoji-cheat-sheet.com/">http://www.emoji-cheat-sheet.com/</a>
+Emojify returns a copy of `s` with all emoji codes replaced with actual emojis.
+
+See http://www.emoji-cheat-sheet.com/
{{< docs/func-aliases "transform.Emojify" >}}
{{< docs/func-examples "transform.Emojify" >}}
@@ -64,11 +66,12 @@ See <a href="http://www.emoji-cheat-sheet.com/">http://www.emoji-cheat-sheet.com
## transform.HTMLEscape {#transform_namespace_htmlescape}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-HTMLEscape returns a copy of s with reserved HTML characters escaped.
+HTMLEscape returns a copy of `s` with reserved HTML characters escaped.
+
{{< docs/func-aliases "transform.HTMLEscape" >}}
{{< docs/func-examples "transform.HTMLEscape" >}}
@@ -80,12 +83,13 @@ HTMLEscape returns a copy of s with reserved HTML characters escaped.
## transform.HTMLUnescape {#transform_namespace_htmlunescape}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
HTMLUnescape returns a copy of with HTML escape requences converted to plain
text.
-
{{< docs/func-aliases "transform.HTMLUnescape" >}}
{{< docs/func-examples "transform.HTMLUnescape" >}}
@@ -97,12 +101,13 @@ text.
## transform.Highlight {#transform_namespace_highlight}
-\([any](/documentation/reference/gotypes/#any),[string](/documentation/reference/gotypes/#string),[...any](/documentation/reference/objects//...any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(s [any](/documentation/reference/gotypes/#any), lang [string](/documentation/reference/gotypes/#string), opts [...any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Highlight returns a copy of s as an HTML string with syntax
-highlighting applied.
+Highlight returns a copy of `s` as an HTML string with syntax
+highlighting applied.
+
{{< docs/func-aliases "transform.Highlight" >}}
{{< docs/func-examples "transform.Highlight" >}}
@@ -114,11 +119,12 @@ highlighting applied.
## transform.HighlightCodeBlock {#transform_namespace_highlightcodeblock}
-\([CodeblockContext](/documentation/reference/objects/markup/converter/hooks/codeblockcontext),[...any](/documentation/reference/objects//...any)\) → [HightlightResult](/documentation/reference/objects/markup/highlight/hightlightresult)
+\(ctx [CodeblockContext](/documentation/reference/objects/markup/converter/hooks/codeblockcontext), opts [...any](/documentation/reference/gotypes/#any)\) → [HightlightResult](/documentation/reference/objects/markup/highlight/hightlightresult)
{.funcsig}
-HighlightCodeBlock highlights a code block on the form received in the codeblock render hooks.
+HighlightCodeBlock highlights a code block on the form received in the codeblock render hooks.
+
{{< docs/func-aliases "transform.HighlightCodeBlock" >}}
{{< docs/func-examples "transform.HighlightCodeBlock" >}}
@@ -130,11 +136,12 @@ HighlightCodeBlock highlights a code block on the form received in the codeblock
## transform.Markdownify {#transform_namespace_markdownify}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(s [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Markdownify renders a given input from Markdown to HTML.
+Markdownify renders a given input from Markdown to HTML.
+
{{< docs/func-aliases "transform.Markdownify" >}}
{{< docs/func-examples "transform.Markdownify" >}}
@@ -146,11 +153,12 @@ Markdownify renders a given input from Markdown to HTML.
## transform.Plainify {#transform_namespace_plainify}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(s [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Plainify returns a copy of s with all HTML tags removed.
+Plainify returns a copy of `s` with all HTML tags removed.
+
{{< docs/func-aliases "transform.Plainify" >}}
{{< docs/func-examples "transform.Plainify" >}}
@@ -162,8 +170,10 @@ Plainify returns a copy of s with all HTML tags removed.
## transform.Remarshal {#transform_namespace_remarshal}
-\([string](/documentation/reference/gotypes/#string),[any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(format [string](/documentation/reference/gotypes/#string), data [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Remarshal is used in the Hugo documentation to convert configuration
examples from YAML to JSON, TOML (and possibly the other way around).
The is primarily a helper for the Hugo docs site.
@@ -171,7 +181,6 @@ It is not a general purpose YAML to TOML converter etc., and may
change without notice if it serves a purpose in the docs.
Format is one of json, yaml or toml.
-
{{< docs/func-aliases "transform.Remarshal" >}}
{{< docs/func-examples "transform.Remarshal" >}}
@@ -186,6 +195,8 @@ Format is one of json, yaml or toml.
\(\) →
{.funcsig}
+
+
{{< docs/func-aliases "transform.Reset" >}}
{{< docs/func-examples "transform.Reset" >}}
@@ -197,13 +208,14 @@ Format is one of json, yaml or toml.
## transform.Unmarshal {#transform_namespace_unmarshal}
-\([...any](/documentation/reference/objects//...any)\) → [any](/documentation/reference/gotypes/#any)
+\(args [...any](/documentation/reference/gotypes/#any)\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
+
Unmarshal unmarshals the data given, which can be either a string, json.RawMessage
or a Resource. Supported formats are JSON, TOML, YAML, and CSV.
You can optionally provide an options map as the first argument.
-
{{< docs/func-aliases "transform.Unmarshal" >}}
{{< docs/func-examples "transform.Unmarshal" >}}
diff --git a/exampleSite/content/en/documentation/reference/functions/tpl/urls/urls/index.md b/exampleSite/content/en/documentation/reference/functions/tpl/urls/urls/index.md
index 0033645..220569a 100644
--- a/exampleSite/content/en/documentation/reference/functions/tpl/urls/urls/index.md
+++ b/exampleSite/content/en/documentation/reference/functions/tpl/urls/urls/index.md
@@ -30,13 +30,14 @@ hugoSymbol: TODO
## urls.AbsLangURL {#urls_namespace_abslangurl}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-AbsLangURL takes a given string and converts it to an absolute URL according
-to a page's position in the project directory structure and the current
-language.
+AbsLangURL takes `a` given string and converts it to an absolute URL according
+to `a` page's position in the project directory structure and the current
+language.
+
{{< docs/func-aliases "urls.AbsLangURL" >}}
{{< docs/func-examples "urls.AbsLangURL" >}}
@@ -48,11 +49,12 @@ language.
## urls.AbsURL {#urls_namespace_absurl}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-AbsURL takes a given string and converts it to an absolute URL.
+AbsURL takes `a` given string and converts it to an absolute URL.
+
{{< docs/func-aliases "urls.AbsURL" >}}
{{< docs/func-examples "urls.AbsURL" >}}
@@ -64,11 +66,12 @@ AbsURL takes a given string and converts it to an absolute URL.
## urls.Anchorize {#urls_namespace_anchorize}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-Anchorize creates sanitized anchor names that are compatible with Blackfriday.
+Anchorize creates sanitized anchor names that are compatible with Blackfriday.
+
{{< docs/func-aliases "urls.Anchorize" >}}
{{< docs/func-examples "urls.Anchorize" >}}
@@ -80,12 +83,13 @@ Anchorize creates sanitized anchor names that are compatible with Blackfriday.
## urls.Parse {#urls_namespace_parse}
-\([any](/documentation/reference/gotypes/#any)\) → [*url.URL](/documentation/reference/objects//*url.url)
+\(rawurl [any](/documentation/reference/gotypes/#any)\) → [url.URL](/documentation/reference/objects//url.url)
{.funcsig}
-Parse parses rawurl into a URL structure. The rawurl may be relative or
-absolute.
+Parse parses `rawurl` into a URL structure. The `rawurl` may be relative or
+absolute.
+
{{< docs/func-aliases "urls.Parse" >}}
{{< docs/func-examples "urls.Parse" >}}
@@ -97,11 +101,12 @@ absolute.
## urls.Ref {#urls_namespace_ref}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(in [any](/documentation/reference/gotypes/#any), args [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Ref returns the absolute URL path to a given content item.
+Ref returns the absolute URL path to a given content item.
+
{{< docs/func-aliases "urls.Ref" >}}
{{< docs/func-examples "urls.Ref" >}}
@@ -113,12 +118,13 @@ Ref returns the absolute URL path to a given content item.
## urls.RelLangURL {#urls_namespace_rellangurl}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-RelLangURL takes a given string and prepends the relative path according to a
-page's position in the project directory structure and the current language.
+RelLangURL takes `a` given string and prepends the relative path according to `a`
+page's position in the project directory structure and the current language.
+
{{< docs/func-aliases "urls.RelLangURL" >}}
{{< docs/func-examples "urls.RelLangURL" >}}
@@ -130,11 +136,12 @@ page's position in the project directory structure and the current language.
## urls.RelRef {#urls_namespace_relref}
-\([any](/documentation/reference/gotypes/#any),[any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(in [any](/documentation/reference/gotypes/#any), args [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-RelRef returns the relative URL path to a given content item.
+RelRef returns the relative URL path to a given content item.
+
{{< docs/func-aliases "urls.RelRef" >}}
{{< docs/func-examples "urls.RelRef" >}}
@@ -146,12 +153,13 @@ RelRef returns the relative URL path to a given content item.
## urls.RelURL {#urls_namespace_relurl}
-\([any](/documentation/reference/gotypes/#any)\) → [HTML](/documentation/reference/objects/html/template/html)
+\(a [any](/documentation/reference/gotypes/#any)\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-RelURL takes a given string and prepends the relative path according to a
-page's position in the project directory structure.
+RelURL takes `a` given string and prepends the relative path according to `a`
+page's position in the project directory structure.
+
{{< docs/func-aliases "urls.RelURL" >}}
{{< docs/func-examples "urls.RelURL" >}}
@@ -163,11 +171,12 @@ page's position in the project directory structure.
## urls.URLize {#urls_namespace_urlize}
-\([any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
+\(a [any](/documentation/reference/gotypes/#any)\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-URLize returns the given argument formatted as URL.
+URLize returns the given argument formatted as URL.
+
{{< docs/func-aliases "urls.URLize" >}}
{{< docs/func-examples "urls.URLize" >}}
diff --git a/exampleSite/content/en/documentation/reference/gotypes/index.md b/exampleSite/content/en/documentation/reference/gotypes/index.md
index c873263..834fc95 100644
--- a/exampleSite/content/en/documentation/reference/gotypes/index.md
+++ b/exampleSite/content/en/documentation/reference/gotypes/index.md
@@ -10,6 +10,11 @@ Consectetur dolore ut fugiat reprehenderit consequat eiusmod adipisicing consect
Adipisicing minim culpa qui magna amet Lorem fugiat sit proident mollit. Magna sint cupidatat ut sint sit commodo irure. Deserunt consectetur cupidatat aliquip magna non aliquip nulla anim. Quis excepteur occaecat ipsum ad consectetur eiusmod excepteur ipsum. Ullamco sunt velit enim dolore voluptate.
+## float
+
+Fugiat ullamco enim ipsum sit fugiat ullamco duis aliqua. Occaecat veniam do commodo ea aliquip consectetur. Est nisi proident voluptate sunt Lorem eiusmod ut nisi laborum adipisicing labore ut in. Mollit eiusmod est Lorem minim velit Lorem sint fugiat nulla quis ex. Elit ipsum velit magna anim duis nostrud adipisicing laboris. Minim laborum non est dolor sit et velit duis nisi consequat aute consequat qui eu.
+
+Sit aute proident velit exercitation esse culpa aliquip commodo fugiat aliqua. Ut reprehenderit aute magna irure elit sit ad. Minim excepteur quis ad mollit non. Lorem duis sunt anim cillum pariatur elit sunt cillum. Qui pariatur ea laborum sint aute Lorem nostrud ullamco. Est duis enim sunt dolor irure nisi sunt proident occaecat dolor.
## bool
@@ -17,6 +22,11 @@ Eu consequat irure labore sit. Occaecat quis tempor veniam tempor quis ullamco i
Irure officia proident commodo consequat ipsum quis duis duis irure. Cillum amet culpa ad veniam pariatur consequat. Elit voluptate laborum quis sunt consequat.
+## map[string]any
+
+Pariatur Lorem magna ea exercitation consectetur nisi. Magna nulla sunt exercitation fugiat dolore ullamco est sit sint do do. Ex nisi in nulla dolor est aute. Qui est deserunt velit laboris proident tempor. Deserunt proident sint cillum irure nulla esse elit tempor voluptate. Duis est adipisicing reprehenderit aliquip dolor ex enim reprehenderit. Nostrud pariatur ex do sit velit duis non velit nisi.
+
+Eu aliquip qui incididunt quis aliqua. Eu elit anim ullamco dolore aliqua officia dolore. Laborum proident enim et laborum amet.
## string
diff --git a/exampleSite/content/en/documentation/reference/objects/hugo/index.md b/exampleSite/content/en/documentation/reference/objects/hugo/index.md
index 07d96f1..60f4840 100644
--- a/exampleSite/content/en/documentation/reference/objects/hugo/index.md
+++ b/exampleSite/content/en/documentation/reference/objects/hugo/index.md
@@ -59,11 +59,12 @@ It can be any string, but it will be all lower case.
## Deps {#hugo_info_deps}
-\(\) → [[]*Dependency](/documentation/reference/objects//[]*dependency)
+\(\) → [*Dependency](/documentation/reference/objects//*dependency)
{.funcsig}
-Deps gets a list of dependencies for this Hugo build.
+Deps gets a list of dependencies for this Hugo build.
+
@@ -72,11 +73,12 @@ Deps gets a list of dependencies for this Hugo build.
## Generator {#hugo_info_generator}
-\(\) → [HTML](/documentation/reference/objects/html/template/html)
+\(\) → [template.HTML](/documentation/reference/gotypes/#templatehtml)
{.funcsig}
-Generator a Hugo meta generator HTML tag.
+Generator a Hugo meta generator HTML tag.
+
@@ -94,6 +96,8 @@ Generator a Hugo meta generator HTML tag.
+
+
## IsProduction {#hugo_info_isproduction}
\(\) → [bool](/documentation/reference/gotypes/#bool)
@@ -105,13 +109,16 @@ Generator a Hugo meta generator HTML tag.
+
+
## Version {#hugo_info_version}
\(\) → [VersionString](/documentation/reference/objects//versionstring)
{.funcsig}
-Version returns the current version as a comparable version string.
+Version returns the current version as a comparable version string.
+
diff --git a/exampleSite/content/en/documentation/reference/objects/langs/language/index.md b/exampleSite/content/en/documentation/reference/objects/langs/language/index.md
index 8b3cb62..5c1984b 100644
--- a/exampleSite/content/en/documentation/reference/objects/langs/language/index.md
+++ b/exampleSite/content/en/documentation/reference/objects/langs/language/index.md
@@ -89,9 +89,10 @@ Weight
\(\) → [Params](/documentation/reference/objects/common/maps/params)
{.funcsig}
-Params returns language-specific params merged with the global params.
+Params returns language-specific params merged with the global params.
+
diff --git a/exampleSite/content/en/documentation/reference/objects/media/type/index.md b/exampleSite/content/en/documentation/reference/objects/media/type/index.md
index e310123..9af772c 100644
--- a/exampleSite/content/en/documentation/reference/objects/media/type/index.md
+++ b/exampleSite/content/en/documentation/reference/objects/media/type/index.md
@@ -22,7 +22,7 @@ hugoSymbol: TODO
## MainType {#media_type_maintype}
-`MainType` is a [string](/documentation/reference/gotypes/#string).
+`MainType` is a {string }.
@@ -30,7 +30,7 @@ hugoSymbol: TODO
## SubType {#media_type_subtype}
-`SubType` is a [string](/documentation/reference/gotypes/#string).
+`SubType` is a {string }.
@@ -38,7 +38,7 @@ hugoSymbol: TODO
## Delimiter {#media_type_delimiter}
-`Delimiter` is a [string](/documentation/reference/gotypes/#string).
+`Delimiter` is a {string }.
@@ -46,7 +46,7 @@ hugoSymbol: TODO
## FirstSuffix {#media_type_firstsuffix}
-`FirstSuffix` is a [SuffixInfo](/documentation/reference/objects//suffixinfo).
+`FirstSuffix` is a {SuffixInfo }.
FirstSuffix holds the first suffix defined for this Type.
@@ -64,6 +64,8 @@ FirstSuffix holds the first suffix defined for this Type.
\(\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
+
+
IsText returns whether this Type is a text format.
Note that this may currently return false negatives.
TODO(bep) improve
@@ -80,14 +82,14 @@ TODO(bep) improve
-
## Suffixes {#media_type_suffixes}
-\(\) → [[]string](/documentation/reference/objects//[]string)
+\(\) → [[]string](/documentation/reference/gotypes/#string)
{.funcsig}
-Suffixes returns all valid file suffixes for this type.
+Suffixes returns all valid file suffixes for this type.
+
@@ -98,6 +100,8 @@ Suffixes returns all valid file suffixes for this type.
\(\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
+
Type returns a string representing the main- and sub-type of a media type, e.g. "text/css".
A suffix identifier will be appended after a "+" if set, e.g. "image/svg+xml".
Hugo will register a set of default media types.
@@ -108,4 +112,3 @@ by defining a media type with the same Type.
-
diff --git a/exampleSite/content/en/documentation/reference/objects/navigation/menus/index.md b/exampleSite/content/en/documentation/reference/objects/navigation/menus/index.md
index 0f210e9..ee5a353 100644
--- a/exampleSite/content/en/documentation/reference/objects/navigation/menus/index.md
+++ b/exampleSite/content/en/documentation/reference/objects/navigation/menus/index.md
@@ -33,9 +33,10 @@ keywords:
\(\) → [Menu](/documentation/reference/objects//menu)
{.funcsig}
-ByName sorts the menu by the name defined in the menu configuration.
+ByName sorts the menu by the name defined in the menu configuration.
+
@@ -46,9 +47,10 @@ ByName sorts the menu by the name defined in the menu configuration.
\(\) → [Menu](/documentation/reference/objects//menu)
{.funcsig}
-ByWeight sorts the menu by the weight defined in the menu configuration.
+ByWeight sorts the menu by the weight defined in the menu configuration.
+
@@ -59,11 +61,12 @@ ByWeight sorts the menu by the weight defined in the menu configuration.
## Limit {#navigation_menu_limit}
-\([int](/documentation/reference/gotypes/#int)\) → [Menu](/documentation/reference/objects//menu)
+\(n [int](/documentation/reference/gotypes/#int)\) → [Menu](/documentation/reference/objects//menu)
{.funcsig}
-Limit limits the returned menu to n entries.
+Limit limits the returned menu to `n` entries.
+
@@ -74,9 +77,10 @@ Limit limits the returned menu to n entries.
\(\) → [Menu](/documentation/reference/objects//menu)
{.funcsig}
-Reverse reverses the order of the menu entries.
+Reverse reverses the order of the menu entries.
+
@@ -87,9 +91,10 @@ Reverse reverses the order of the menu entries.
\(\) → [Menu](/documentation/reference/objects//menu)
{.funcsig}
-Sort sorts the menu by weight, name and then by identifier.
+Sort sorts the menu by weight, name and then by identifier.
+
@@ -231,9 +236,10 @@ Params
\(\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-HasChildren returns whether this menu item has any children.
+HasChildren returns whether this menu item has any children.
+
@@ -242,11 +248,12 @@ HasChildren returns whether this menu item has any children.
## IsEqual {#navigation_menuentry_isequal}
-\([*MenuEntry](/documentation/reference/objects//*menuentry)\) → [bool](/documentation/reference/gotypes/#bool)
+\(inme [MenuEntry](/documentation/reference/objects//menuentry)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
-IsEqual returns whether the two menu entries represents the same menu entry.
+IsEqual returns whether the two menu entries represents the same menu entry.
+
@@ -255,8 +262,10 @@ IsEqual returns whether the two menu entries represents the same menu entry.
## IsSameResource {#navigation_menuentry_issameresource}
-\([*MenuEntry](/documentation/reference/objects//*menuentry)\) → [bool](/documentation/reference/gotypes/#bool)
+\(inme [MenuEntry](/documentation/reference/objects//menuentry)\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
+
+
IsSameResource returns whether the two menu entries points to the same
resource (URL).
@@ -266,14 +275,14 @@ resource (URL).
-
## KeyName {#navigation_menuentry_keyname}
\(\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
-KeyName returns the key used to identify this menu entry.
+KeyName returns the key used to identify this menu entry.
+
@@ -293,6 +302,8 @@ KeyName returns the key used to identify this menu entry.
+
+
## URL {#navigation_menuentry_url}
\(\) → [string](/documentation/reference/gotypes/#string)
@@ -302,6 +313,8 @@ KeyName returns the key used to identify this menu entry.
+
+
Menus is a map from string to [Menu](#navigation_menu).
diff --git a/exampleSite/content/en/documentation/reference/objects/site/index.md b/exampleSite/content/en/documentation/reference/objects/site/index.md
index 21f9472..0659cfe 100644
--- a/exampleSite/content/en/documentation/reference/objects/site/index.md
+++ b/exampleSite/content/en/documentation/reference/objects/site/index.md
@@ -22,8 +22,9 @@ weight: 10
## Language {#page_site_language}
-\(\) → [*langs.Language](/documentation/reference/objects//*langs.language)
+\(\) → [langs.Language](/documentation/reference/objects//langs.language)
{.funcsig}
+
Returns the `Language` configured for this Site.
@@ -32,6 +33,7 @@ Returns the `Language` configured for this Site.
## RegularPages {#page_site_regularpages}
\(\) → [Pages](/documentation/reference/objects//pages)
{.funcsig}
+
Returns all the regular Pages in this Site.
@@ -40,6 +42,7 @@ Returns all the regular Pages in this Site.
## Pages {#page_site_pages}
\(\) → [Pages](/documentation/reference/objects//pages)
{.funcsig}
+
Returns all `Pages` in this Site.
@@ -48,6 +51,7 @@ Returns all `Pages` in this Site.
## Home {#page_site_home}
\(\) → [Page](/documentation/reference/objects//page)
{.funcsig}
+
A shortcut to the home page.
@@ -56,6 +60,7 @@ A shortcut to the home page.
## IsServer {#page_site_isserver}
\(\) → [bool](/documentation/reference/gotypes/#bool)
{.funcsig}
+
Returns true if we're running in a server.
@@ -64,6 +69,7 @@ Returns true if we're running in a server.
## ServerPort {#page_site_serverport}
\(\) → [int](/documentation/reference/gotypes/#int)
{.funcsig}
+
Returns the server port.
@@ -72,6 +78,7 @@ Returns the server port.
## Title {#page_site_title}
\(\) → [string](/documentation/reference/gotypes/#string)
{.funcsig}
+
Returns the configured title for this Site.
@@ -80,6 +87,7 @@ Returns the configured title for this Site.
## Sites {#page_site_sites}
\(\) → [Sites](/documentation/reference/objects//sites)
{.funcsig}
+
Returns all `Sites` for all languages.
@@ -88,6 +96,7 @@ Returns all `Sites` for all languages.
## Current {#page_site_current}
\(\) → [Site](/documentation/reference/objects//site)
{.funcsig}
+
Returns Site currently rendering.
@@ -96,6 +105,7 @@ Returns Site currently rendering.
## Hugo {#page_site_hugo}
\(\) → [Info](/documentation/reference/objects/common/hugo/info)
{.funcsig}
+
Returns a struct with some information about the build.
@@ -104,6 +114,7 @@ Returns a struct with some information about the build.
## BaseURL {#page_site_baseurl}
\(\) → [URL](/documentation/reference/objects/html/template/url)
{.funcsig}
+
Returns the `BaseURL` for this Site.
@@ -112,6 +123,7 @@ Returns the `BaseURL` for this Site.
## Taxonomies {#page_site_taxonomies}
\(\) → [any](/documentation/reference/gotypes/#any)
{.funcsig}
+
Retuns a taxonomy map.
@@ -120,6 +132,7 @@ Retuns a taxonomy map.
## LastChange {#page_site_lastchange}
\(\) → [time.Time](/documentation/reference/gotypes/#timetime)
{.funcsig}
+
Returns the last modification date of the content.
@@ -128,6 +141,7 @@ Returns the last modification date of the content.
## Menus {#page_site_menus}
\(\) → [Menus](/documentation/reference/objects/navigation/menus)
{.funcsig}
+
Returns the `Menus` for this site.
@@ -136,14 +150,16 @@ Returns the `Menus` for this site.
## Params {#page_site_params}
\(\) → [Params](/documentation/reference/objects/common/maps/params)
{.funcsig}
+
Returns the `Params` configured for this site.
## Data {#page_site_data}
-\(\) → [map[string]any](/documentation/reference/objects//map[string]any)
+\(\) → [map[string]any](/documentation/reference/gotypes/#mapstringany)
{.funcsig}
+
Returns a map of all the data inside /data.
diff --git a/exampleSite/go.mod b/exampleSite/go.mod
index b0a3139..abb298f 100644
--- a/exampleSite/go.mod
+++ b/exampleSite/go.mod
@@ -6,4 +6,8 @@ replace github.com/gohugoio/gohugoioTheme2 => ../
require github.com/gohugoio/hugoDocs v0.98.0
-require github.com/gohugoio/gohugoioTheme2 v0.0.0-20220302165724-cf9a8cd9ad19 // indirect
+require (
+ github.com/gohugoio/gohugoioTheme2 v0.0.0-20220302165724-cf9a8cd9ad19 // indirect
+ github.com/hotwired/turbo v7.1.0+incompatible // indirect
+ github.com/instantpage/instant.page v5.1.0+incompatible // indirect
+)
diff --git a/exampleSite/go.sum b/exampleSite/go.sum
index 608af10..13af3f3 100644
--- a/exampleSite/go.sum
+++ b/exampleSite/go.sum
@@ -13,6 +13,9 @@ github.com/gohugoio/hugoDocs v0.81.1-0.20220302165412-259c65c8d5b8/go.mod h1:Mdx
github.com/gohugoio/hugoDocs v0.98.0 h1:SFNQSzNl4bDjL0zzzJlVRqaD2JuBYM3g9AbG+Dj1IP0=
github.com/gohugoio/hugoDocs v0.98.0/go.mod h1:0onYkT4Fe1qF5OxwKdyKkb8KMj0EPi/PENTy4CSpOQI=
github.com/hotwired/turbo v7.0.1+incompatible/go.mod h1:6XcpYEC+j8xb7URpSYwhlq4iq98M5F5T/jaLWNHVbZs=
+github.com/hotwired/turbo v7.1.0+incompatible h1:+a6SIF+fcVR59cOpMneuReqiGjfTI66BuMg9HHa5dHQ=
+github.com/hotwired/turbo v7.1.0+incompatible/go.mod h1:6XcpYEC+j8xb7URpSYwhlq4iq98M5F5T/jaLWNHVbZs=
+github.com/instantpage/instant.page v5.1.0+incompatible h1:/Z2XRXfY5HwuCN3TTqo56PaFyIlDr4l3tyytR/jGHXI=
github.com/instantpage/instant.page v5.1.0+incompatible/go.mod h1:GXVDktwI+K4T9o5mcK2NYDqPFxAUrB9U9goR9oG1SaI=
github.com/ryangjchandler/spruce v2.6.4+incompatible/go.mod h1:pERscuhekU9NhSgrY8l7/0nLN1rBGBVnpvkMrVwGAZU=
github.com/turbolinks/turbolinks-source-gem v5.2.0+incompatible/go.mod h1:Cl0Br9tUXkQvxumVNGTvyaa7dqpFC2kPMrsS0Ttc94U=