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.md40
-rw-r--r--docs/content/en/functions/encoding/Base64Encode.md17
-rw-r--r--docs/content/en/functions/encoding/Jsonify.md37
-rw-r--r--docs/content/en/functions/encoding/_index.md12
4 files changed, 106 insertions, 0 deletions
diff --git a/docs/content/en/functions/encoding/Base64Decode.md b/docs/content/en/functions/encoding/Base64Decode.md
new file mode 100644
index 000000000..821ca805a
--- /dev/null
+++ b/docs/content/en/functions/encoding/Base64Decode.md
@@ -0,0 +1,40 @@
+---
+title: encoding.Base64Decode
+description: Returns the base64 decoding of the given content.
+categories: []
+keywords: []
+action:
+ aliases: [base64Decode]
+ related:
+ - functions/encoding/Base64Encode
+ returnType: string
+ signatures: [encoding.Base64Decode INPUT]
+aliases: [/functions/base64Decode]
+---
+
+```go-html-template
+{{ "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:
+
+```text
+https://api.github.com/repos/gohugoio/hugo/readme
+```
+
+To retrieve and render the content:
+
+```go-html-template
+{{ $u := "https://api.github.com/repos/gohugoio/hugo/readme" }}
+{{ with resources.GetRemote $u }}
+ {{ with .Err }}
+ {{ errorf "%s" . }}
+ {{ else }}
+ {{ with . | transform.Unmarshal }}
+ {{ .content | base64Decode | markdownify }}
+ {{ end }}
+ {{ end }}
+{{ else }}
+ {{ errorf "Unable to get remote resource %q" $u }}
+{{ end }}
+```
diff --git a/docs/content/en/functions/encoding/Base64Encode.md b/docs/content/en/functions/encoding/Base64Encode.md
new file mode 100644
index 000000000..14f67a132
--- /dev/null
+++ b/docs/content/en/functions/encoding/Base64Encode.md
@@ -0,0 +1,17 @@
+---
+title: encoding.Base64Encode
+description: Returns the base64 decoding of the given content.
+categories: []
+keywords: []
+action:
+ aliases: [base64Encode]
+ related:
+ - functions/encoding/Base64Decode
+ returnType: string
+ signatures: [encoding.Base64Encode INPUT]
+aliases: [/functions/base64, /functions/base64Encode]
+---
+
+```go-html-template
+{{ "Hugo" | base64Encode }} → SHVnbw==
+```
diff --git a/docs/content/en/functions/encoding/Jsonify.md b/docs/content/en/functions/encoding/Jsonify.md
new file mode 100644
index 000000000..475f8a76a
--- /dev/null
+++ b/docs/content/en/functions/encoding/Jsonify.md
@@ -0,0 +1,37 @@
+---
+title: encoding.Jsonify
+description: Encodes the given object to JSON.
+categories: []
+keywords: []
+action:
+ aliases: [jsonify]
+ returnType: template.HTML
+ related:
+ - functions/transform/Remarshal
+ - functions/transform/Unmarshal
+ signatures:
+ - encoding.Jsonify [OPTIONS] INPUT
+aliases: [/functions/jsonify]
+---
+
+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" " ") }}
+{{ dict "title" .Title "content" .Plain | jsonify (dict "prefix" " " "indent" " ") }}
+```
+
+## Options
+
+indent
+: (`string`) Indentation to use. Default is "".
+
+prefix
+: (`string`) Indentation prefix. Default is "".
+
+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.