Update documentation

This commit is contained in:
Mircea-Pavel ANTON 2023-01-25 13:34:41 +00:00
parent 455ecae53d
commit a92ca86201

View file

@ -19,24 +19,40 @@ The input is written in Markdown so you can format it however you please.
By default, the alert is presented with an exclaimation triangle icon. To change the icon, include the icon name in the shortcode. Check out the [icon shortcode](#icon) for more details on using icons. By default, the alert is presented with an exclaimation triangle icon. To change the icon, include the icon name in the shortcode. Check out the [icon shortcode](#icon) for more details on using icons.
**Example:** **Example 1:**
```md ```md
{{</* alert */>}} {{</* alert */>}}
**Warning!** This action is destructive! **Warning!** This action is destructive!
{{</* /alert */>}} {{</* /alert */>}}
{{</* alert "twitter" */>}}
Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter.
{{</* /alert */>}}
``` ```
{{< alert >}} {{< alert >}}
**Warning!** This action is destructive! **Warning!** This action is destructive!
{{< /alert >}} {{< /alert >}}
&nbsp;
{{< alert "twitter" >}} **Example 2:**
```md
{{</* alert icon="twitter" */>}}
Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter. Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter.
{{</* /alert */>}}
```
{{< alert icon="twitter" >}}
Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter.
{{< /alert >}}
**Example 3:**
```md
{{</* alert icon="fire" cardColor="red" iconColor="black" textColor="white" */>}}
This is an error!
{{</* /alert */>}}
```
{{< alert icon="fire" cardColor="red" iconColor="black" textColor="white" >}}
This is an error!
{{< /alert >}} {{< /alert >}}
<br/><br/><br/> <br/><br/><br/>