This article shows how to use the alert shortcode.
Important
Since
v1.8.0, you can create alerts without shortcode, see blockquote alerts.
Syntax
Inline
1{{< alert [type] >}}INLINE ALERT{{< /alert >}}
Block
1{{< alert [type] >}}
2BLOCK ALERT
3{{< /alert >}}
The parameter
typeis optional. Default toinfo, available values:info,success,warninganddanger.
With Heading
1{{< alert [type] >}}
2{{< alert-heading >}}Well Done!{{< /alert-heading >}}
3ALERT MESSAGE
4{{< /alert >}}
With Markdown Syntax
1{{% alert warning %}}
2Alert Shortcode with Markdown Syntax:
3```bash
4$ echo 'An example of alert shortcode with the Markdown syntax'
5```
6{{% /alert %}}
Alert Shortcode with Markdown Syntax:
1$ echo 'An example of alert shortcode with the Markdown syntax'
Please note that you’ll need to enable the markup.goldmark.renderer.unsafe configuration.
config.toml
1[markup]
2 [markup.goldmark]
3 [markup.goldmark.renderer]
4 unsafe = true
config.yaml
1markup:
2 goldmark:
3 renderer:
4 unsafe: true
config.json
1{
2 "markup": {
3 "goldmark": {
4 "renderer": {
5 "unsafe": true
6 }
7 }
8 }
9}
Examples
Primary
Info
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.
Warning
Danger
Comments