summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/encoding
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/encoding')
-rw-r--r--docs/content/en/functions/encoding/Base64Decode.md15
-rw-r--r--docs/content/en/functions/encoding/Base64Encode.md15
-rw-r--r--docs/content/en/functions/encoding/Jsonify.md41
-rw-r--r--docs/content/en/functions/encoding/_index.md12
4 files changed, 37 insertions, 46 deletions
diff --git a/docs/content/en/functions/encoding/Base64Decode.md b/docs/content/en/functions/encoding/Base64Decode.md
index 8bd554c83..821ca805a 100644
--- a/docs/content/en/functions/encoding/Base64Decode.md
+++ b/docs/content/en/functions/encoding/Base64Decode.md
@@ -1,24 +1,19 @@
---
title: encoding.Base64Decode
-linkTitle: base64Decode
description: Returns the base64 decoding of the given content.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [base64Decode]
+ related:
+ - functions/encoding/Base64Encode
returnType: string
signatures: [encoding.Base64Decode INPUT]
-signatures:
- -
- - base64Decode INPUT
aliases: [/functions/base64Decode]
---
```go-html-template
-{{ "SHVnbw==" | base64Decode }} → "Hugo"
+{{ "SHVnbw==" | base64Decode }} → Hugo
```
Use the `base64Decode` function to decode responses from APIs. For example, the result of this call to GitHub's API contains the base64-encoded representation of the repository's README file:
diff --git a/docs/content/en/functions/encoding/Base64Encode.md b/docs/content/en/functions/encoding/Base64Encode.md
index d548aca8e..14f67a132 100644
--- a/docs/content/en/functions/encoding/Base64Encode.md
+++ b/docs/content/en/functions/encoding/Base64Encode.md
@@ -1,22 +1,17 @@
---
title: encoding.Base64Encode
-linkTitle: base64Encode
description: Returns the base64 decoding of the given content.
-categories: [functions]
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [base64Encode]
+ related:
+ - functions/encoding/Base64Decode
returnType: string
signatures: [encoding.Base64Encode INPUT]
-relatedFunctions:
- - encoding.Base64Decode
- - encoding.Base64Encode
aliases: [/functions/base64, /functions/base64Encode]
---
```go-html-template
-{{ "Hugo" | base64Encode }} → "SHVnbw=="
+{{ "Hugo" | base64Encode }} → SHVnbw==
```
diff --git a/docs/content/en/functions/encoding/Jsonify.md b/docs/content/en/functions/encoding/Jsonify.md
index 0b9cb2e74..475f8a76a 100644
--- a/docs/content/en/functions/encoding/Jsonify.md
+++ b/docs/content/en/functions/encoding/Jsonify.md
@@ -1,31 +1,24 @@
---
title: encoding.Jsonify
-linkTitle: jsonify
-description: Encodes a given object to JSON.
-categories: [functions]
+description: Encodes the given object to JSON.
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [jsonify]
returnType: template.HTML
+ related:
+ - functions/transform/Remarshal
+ - functions/transform/Unmarshal
signatures:
- - encoding.Jsonify INPUT
- - encoding.Jsonify OPTIONS INPUT
-relatedFunctions:
- - encoding.Jsonify
- - transform.Remarshal
- - transform.Unmarshal
+ - encoding.Jsonify [OPTIONS] INPUT
aliases: [/functions/jsonify]
---
-To customize the printing of the JSON, pass a map of options as the first
-argument. Supported options are "prefix" and "indent". Each JSON element in
+To customize the printing of the JSON, pass an options map 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.
-
```go-html-template
{{ dict "title" .Title "content" .Plain | jsonify }}
{{ dict "title" .Title "content" .Plain | jsonify (dict "indent" " ") }}
@@ -34,15 +27,11 @@ more copies of *indent* according to the indentation nesting.
## Options
-indent ("")
-: Indentation to use.
-
-prefix ("")
-: Indentation prefix.
-
-noHTMLEscape (false)
-: Disable escaping of problematic HTML characters inside JSON quoted strings. The default behavior is to escape &, <, and > to \u0026, \u003c, and \u003e to avoid certain safety problems that can arise when embedding JSON in HTML.
+indent
+: (`string`) Indentation to use. Default is "".
-See also the `.PlainWords`, `.Plain`, and `.RawContent` [page variables][pagevars].
+prefix
+: (`string`) Indentation prefix. Default is "".
-[pagevars]: /variables/page/
+noHTMLEscape
+: (`bool`) Disable escaping of problematic HTML characters inside JSON quoted strings. The default behavior is to escape `&`, `<`, and `>` to `\u0026`, `\u003c`, and `\u003e` to avoid certain safety problems that can arise when embedding JSON in HTML. Default is `false`.
diff --git a/docs/content/en/functions/encoding/_index.md b/docs/content/en/functions/encoding/_index.md
new file mode 100644
index 000000000..3c4c4519e
--- /dev/null
+++ b/docs/content/en/functions/encoding/_index.md
@@ -0,0 +1,12 @@
+---
+title: Encoding functions
+linkTitle: encoding
+description: Template functions to encode and decode data.
+categories: []
+keywords: []
+menu:
+ docs:
+ parent: functions
+---
+
+Use these functions to encode and decode data.