docs: Prepare for new sub tree

See #11925
This commit is contained in:
Bjørn Erik Pedersen
2024-01-27 10:47:28 +01:00
parent 1083bf7c08
commit fc7de7136a
1157 changed files with 0 additions and 64232 deletions

View File

@@ -1,40 +0,0 @@
---
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 }}
```

View File

@@ -1,17 +0,0 @@
---
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==
```

View File

@@ -1,37 +0,0 @@
---
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`.

View File

@@ -1,12 +0,0 @@
---
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.