shithub: hugo

Info  •  Files  •  Log  •  Branches

docs: Document shuffle template func

Fixes #2393.

--- a/docs/content/templates/functions.md

+++ b/docs/content/templates/functions.md

@@ -97,6 +97,18 @@

 ```

+### shuffle

+

+`shuffle` returns a random permutation of a given array or slice, e.g.

+

+```html

+{{ shuffle (seq 1 5) }}

+<!-- returns [2 5 3 1 4] -->

+

+{{ shuffle (slice "foo" "bar" "buzz") }}

+<!-- returns [buzz foo bar] -->

+```

+

 ### echoParam

 Prints a parameter if it is set.

@@ -128,7 +140,7 @@

 e.g.

-   {{ dict "title" .Title "content" .Plain | jsonify }}

+    {{ dict "title" .Title "content" .Plain | jsonify }}

 ### last

 Slices an array to only the last _N_ elements.