hugo

commit 38d034df38b385d50160071f794cf3331b5cda24
parent 6eff9e501534dfa952b059f446faf9eff097aef7
Author: digitalcraftsman <digitalcraftsman@protonmail.com>
Date:   Mon, 29 Aug 2016 12:22:37 +0200

docs: Document shuffle template func

Fixes #2393.

Diffstat:
M
docs/content/templates/functions.md
 | 
14
+++++++++++++-

1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md
@@ -97,6 +97,18 @@ One use case is the concatenation of elements in combination with `delimit`:
 ```
 
 
+### 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 @@ Encodes a given object to JSON.
 
 e.g.
 
-   {{ dict "title" .Title "content" .Plain | jsonify }}
+    {{ dict "title" .Title "content" .Plain | jsonify }}
 
 ### last
 Slices an array to only the last _N_ elements.