Hugo Encoder Module
Encode text to protect email address and telephone number from spam bots.
On this page
Donate
Please check out the tutorial to
start using Hugo modules.
| Module |
|---|
github.com/hugomods/encoder |
 |
Shortcodes
encode Shortcode
encode Shortcode Syntax
1{{< encode [text] >}}
encode Shortcode Parameters
text
| Position | Name | Type | Required | Default | Since |
|---|---|---|---|---|---|
#0 | text | string | ✓ | - | - |
The text to be encoded.
Encode Plain Email
1{{< encode "user@example.org" >}}Encode Plain Telephone Number
1{{< encode "123-12345678" >}}encode-link Shortcode
encode-link Shortcode Syntax
1{{< encode-link [protocol] [target] [text] >}}
encode-link Shortcode Parameters
protocol
| Position | Name | Type | Required | Default | Since |
|---|---|---|---|---|---|
#0 | protocol | string | ✓ | - | - |
The link protocol, e.g. mailto, tel.
target
| Position | Name | Type | Required | Default | Since |
|---|---|---|---|---|---|
#1 | target | string | ✓ | - | - |
The target of link, such as email address ([email protected]), telephone number (123-12345678).
text
| Position | Name | Type | Required | Default | Since |
|---|---|---|---|---|---|
#0 | text | string | - | - | - |
The link text, default to the target.
*
| Position | Name | Type | Required | Default | Since |
|---|---|---|---|---|---|
| - | * | string | - | - | - |
Others parameter will be treated as the link attributes, such as class, rel.
encode-link Email Examples
1{{< encode-link "mailto" "user@example.org" >}}
2
3{{< encode-link protocol="mailto" target="[email protected]" text="Send me an email." >}}
4
5{{< encode-link protocol="mailto" target="[email protected]" text="Send me an email." class="text-success" >}}encode-link Telephone Number Examples
1{{< encode-link "tel" "123-1234567" >}}
2
3{{< encode-link protocol="tel" target="123-12345678" text="Call me." >}}
4
5{{< encode-link protocol="tel" target="123-12345678" text="Call me." class="text-success" >}}encode-email Shortcode
A shorthand of encode-link for email address that without requirements of specifying the protocol parameter.
1{{< encode-email [target] [text] >}}
encode-tel Shortcode
A shorthand of encode-link for telephone number that without requirements of specifying the protocol parameter.
1{{< encode-tel [target] [text] >}}