hugo/docs/content/functions/base64.md
2017-09-21 19:05:40 +02:00

1.6 KiB

title description godocref date publishdate lastmod categories menu keywords relatedfuncs signature workson hugoversion deprecated draft aliases
base64 `base64Encode` and `base64Decode` let you easily decode content with a base64 encoding and vice versa through pipes. 2017-02-01 2017-02-01 2017-02-01
functions
docs
parent
functions
base64Decode INPUT
base64Encode INPUT
false false

An example:

{{< code file="base64-input.html" >}}

Hello world = {{ "Hello world" | base64Encode }}

SGVsbG8gd29ybGQ = {{ "SGVsbG8gd29ybGQ=" | base64Decode }}

{{< /code >}}

{{< output file="base-64-output.html" >}}

Hello world = SGVsbG8gd29ybGQ=

SGVsbG8gd29ybGQ = Hello world

{{< /output >}}

You can also pass other data types as arguments to the template function which tries to convert them. The following will convert 42 from an integer to a string because both base64Encode and base64Decode always return a string.

{{ 42 | base64Encode | base64Decode }}
=> "42" rather than 42

base64 with APIs

Using base64 to decode and encode becomes really powerful if we have to handle responses from APIs.

{{ $resp := getJSON "https://api.github.com/repos/gohugoio/hugo/readme"  }}
{{ $resp.content | base64Decode | markdownify }}

The response of the GitHub API contains the base64-encoded version of the README.md in the Hugo repository. Now we can decode it and parse the Markdown. The final output will look similar to the rendered version on GitHub.