Include RenderString example for emoji shortcodes

This commit is contained in:
Joe Mooring
2023-11-15 13:05:28 -08:00
committed by Joe Mooring
parent 783fdd3ac3
commit 9bb7f8c785
+12 -7
View File
@@ -1,7 +1,7 @@
---
title: Emoji quick reference guide
linkTitle: Emojis
description: Include emoji shortcodes in your markdown, or use the emojify function in your templates.
description: Include emoji shortcodes in your markdown or templates.
categories: [quick reference]
keywords: [emoji]
menu:
@@ -12,6 +12,12 @@ weight: 40
toc: true
---
Configure Hugo to enable emoji processing in markdown:
{{< code-toggle file=hugo >}}
enableEmoji = true
{{< /code-toggle >}}
With emoji processing enabled, this markdown:
```md
@@ -26,15 +32,14 @@ Hello! &#x1f44b;
And in your browser... Hello! :wave:
To enable this capability in your site configuration:
To process an emoji shortcode from within a template, use the [`emojify`] function or pass the string through the [`RenderString`] method on a `Page` object:
{{< code-toggle file=hugo >}}
enableEmoji = true
{{< /code-toggle >}}
To process an emoji shortcode from within a template, use the [`emojify`] function.
```go-html-template
{{ "Hello! :wave:" | .RenderString }}
```
[`emojify`]: /functions/transform/emojify
[`RenderString`]: /methods/page/renderstring
## Introduction