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

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/shuffle.md')
-rw-r--r--docs/content/en/functions/shuffle.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/content/en/functions/shuffle.md b/docs/content/en/functions/shuffle.md
new file mode 100644
index 000000000..9945ba752
--- /dev/null
+++ b/docs/content/en/functions/shuffle.md
@@ -0,0 +1,39 @@
+---
+title: shuffle
+# linktitle:
+description: Returns a random permutation of a given array or slice.
+godocref:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-04-30
+keywords: [ordering]
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+signature: ["shuffle COLLECTION"]
+workson: []
+hugoversion:
+relatedfuncs: [seq]
+deprecated: false
+draft: false
+aliases: []
+---
+
+{{< code file="shuffle-input.html" >}}
+<!-- Shuffled sequence = -->
+<div>{{ shuffle (seq 1 5) }}</div>
+<!-- Shuffled slice = -->
+<div>{{ shuffle (slice "foo" "bar" "buzz") }}</div>
+{{< /code >}}
+
+This example would return the following:
+
+{{< output file="shuffle-output.html" >}}
+<!-- Shuffled sequence = -->
+<div>2 5 3 1 4</div>
+<!-- Shuffled slice = -->
+<div>buzz foo bar</div>
+{{< /output >}}
+
+This example also makes use of the [slice](/functions/slice/) and [seq](/functions/seq/) functions.