summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/encoding/Jsonify.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/encoding/Jsonify.md')
-rw-r--r--docs/content/en/functions/encoding/Jsonify.md37
1 files changed, 37 insertions, 0 deletions
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`.