mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 07:42:05 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
1.8 KiB
1.8 KiB
title | description | categories | keywords | action | aliases | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
transform.Remarshal | Marshals a string of serialized data, or a map, into a string of serialized data in the specified format. |
|
|
The format must be one of json
, toml
, yaml
, or xml
. If the input is a string of serialized data, it must be valid JSON, TOML, YAML, or XML.
{{% note %}} This function is primarily a helper for Hugo's documentation, used to convert configuration and front matter examples to JSON, TOML, and YAML.
This is not a general purpose converter, and may change without notice if required for Hugo's documentation site. {{% /note %}}
- Example 1
- Convert a string of TOML to JSON.
{{ $s := `
baseURL = 'https://example.org/'
languageCode = 'en-US'
title = 'ABC Widgets'
`}}
<pre>{{ transform.Remarshal "json" $s }}</pre>
Resulting HTML:
<pre>{
"baseURL": "https://example.org/",
"languageCode": "en-US",
"title": "ABC Widgets"
}
</pre>
Rendered in browser:
{
"baseURL": "https://example.org/",
"languageCode": "en-US",
"title": "ABC Widgets"
}
- Example 2
- Convert a map to YAML.
{{ $m := dict
"a" "Hugo rocks!"
"b" (dict "question" "What is 6x7?" "answer" 42)
"c" (slice "foo" "bar")
}}
<pre>{{ transform.Remarshal "yaml" $m }}</pre>
Resulting HTML:
<pre>a: Hugo rocks!
b:
answer: 42
question: What is 6x7?
c:
- foo
- bar
</pre>
Rendered in browser:
a: Hugo rocks!
b:
answer: 42
question: What is 6x7?
c:
- foo
- bar