summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/encoding/Jsonify.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-12-04 15:24:01 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-12-04 15:24:01 +0100
commitd19ed4d4e69f51873135f05a51831d25ecc2071e (patch)
tree74dfd9af2b0f4a6c0933266c50ceaa569d388c71 /docs/content/en/functions/encoding/Jsonify.md
parent9f978d387f8b7cb6bc03fe6b4dd52bb16862a784 (diff)
parent35dec7c96f7ee3eb17dd444f7067f0c776fb56ae (diff)
downloadhugo-d19ed4d4e69f51873135f05a51831d25ecc2071e.tar.gz
hugo-d19ed4d4e69f51873135f05a51831d25ecc2071e.zip
Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae'
Diffstat (limited to 'docs/content/en/functions/encoding/Jsonify.md')
-rw-r--r--docs/content/en/functions/encoding/Jsonify.md41
1 files changed, 15 insertions, 26 deletions
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`.