summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/encoding/Jsonify.md
blob: 475f8a76afabc28c788d4df12bfd13b1ba6b12ca (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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`.