summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoe Mooring <joe.mooring@veriphor.com>2021-05-10 08:18:37 -0700
committerGitHub <noreply@github.com>2021-05-10 17:18:37 +0200
commit2c7f5b62f6c1fa1c7b3cf2c1f3a1663b18e75004 (patch)
tree18911c312c91941bc94300769f440e3468afb859 /docs
parentc46fc838a9320adfc6532b1b543e903c48b3b4cb (diff)
docs: Update querify function description and examples
The querify function now accepts a slice per #8305.
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/functions/querify.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/content/en/functions/querify.md b/docs/content/en/functions/querify.md
index e90e07450..7c361f326 100644
--- a/docs/content/en/functions/querify.md
+++ b/docs/content/en/functions/querify.md
@@ -1,7 +1,7 @@
---
title: querify
linktitle: querify
-description: Takes a set of key-value pairs and returns a query string to be appended to URLs.
+description: Takes a set or slice of key-value pairs and returns a query string to be appended to URLs.
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@@ -11,7 +11,7 @@ menu:
parent: "functions"
keywords: [urls]
godocref:
-signature: ["querify KEY VALUE [KEY VALUE]..."]
+signature: ["querify KEY VALUE [KEY VALUE]...", "querify COLLECTION"]
hugoversion:
deprecated: false
workson: []
@@ -19,16 +19,19 @@ relatedfuncs: []
aliases: []
---
-`querify` takes a set of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL. E.g.
+`querify` takes a set or slice of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL.
-The following example creates a link to a search results page on Google.
+The following examples create a link to a search results page on Google.
-```
+```go-html-template
<a href="https://www.google.com?{{ (querify "q" "test" "page" 3) | safeURL }}">Search</a>
+
+{{ $qs := slice "q" "test" "page" 3 }}
+<a href="https://www.google.com?{{ (querify $qs) | safeURL }}">Search</a>
```
-This example renders the following HTML:
+Both of these examples render the following HTML:
-```
+```html
<a href="https://www.google.com?page=3&q=test">Search</a>
```