hugo-theme-relearn/exampleSite/content/shortcodes/notice.en.md

193 lines
3.1 KiB
Markdown
Raw Normal View History

2017-08-20 15:10:29 +00:00
---
title: Notice
2021-07-16 20:04:22 +00:00
description: "Disclaimers to help you structure your page"
2017-08-20 15:10:29 +00:00
---
2021-07-16 20:04:22 +00:00
The notice shortcode shows four types of disclaimers to help you structure your page.
2017-08-20 15:10:29 +00:00
2021-07-16 20:04:22 +00:00
## Usage
2017-08-20 15:10:29 +00:00
````go
2021-07-16 20:04:22 +00:00
{{%/* notice [ note | info | tip | warning ] */%}}
Some markup
2017-08-20 15:10:29 +00:00
{{%/* /notice */%}}
2021-07-16 20:04:22 +00:00
````
2017-08-20 15:10:29 +00:00
2021-07-16 20:04:22 +00:00
## Examples
2021-07-16 20:04:22 +00:00
### Note
2017-08-20 15:10:29 +00:00
{{% notice note %}}
2021-07-16 20:04:22 +00:00
A **notice** disclaimer
You can add:
2021-07-16 20:04:22 +00:00
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
```
> the possiblities are endless
2017-08-20 15:10:29 +00:00
{{% /notice %}}
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" %}}
````go
2021-07-16 20:04:22 +00:00
{{%/* notice note */%}}
A **notice** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
2017-08-20 15:10:29 +00:00
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
2017-08-20 15:10:29 +00:00
```
2021-07-16 20:04:22 +00:00
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Info
2017-08-20 15:10:29 +00:00
{{% notice info %}}
2021-07-16 20:04:22 +00:00
An **information** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
```
> the possiblities are endless
2017-08-20 15:10:29 +00:00
{{% /notice %}}
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" %}}
````go
2021-07-16 20:04:22 +00:00
{{%/* notice info */%}}
An **information** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
2017-08-20 15:10:29 +00:00
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
2017-08-20 15:10:29 +00:00
```
2021-07-16 20:04:22 +00:00
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Tip
2017-08-20 15:10:29 +00:00
{{% notice tip %}}
2021-07-16 20:04:22 +00:00
A **tip** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
```
> the possiblities are endless
2017-08-20 15:10:29 +00:00
{{% /notice %}}
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" %}}
````go
2021-07-16 20:04:22 +00:00
{{%/* notice tip */%}}
A **tip** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
2017-08-20 15:10:29 +00:00
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
2017-08-20 15:10:29 +00:00
```
2021-07-16 20:04:22 +00:00
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Warning
2017-08-20 15:10:29 +00:00
{{% notice warning %}}
2021-07-16 20:04:22 +00:00
A **warning** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
```
> the possiblities are endless
{{% /notice %}}
2021-07-16 20:04:22 +00:00
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" %}}
````go
2021-07-16 20:04:22 +00:00
{{%/* notice warning */%}}
A **warning** disclaimer
You can add:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text
2021-07-16 20:04:22 +00:00
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```plaintext
2021-07-16 20:04:22 +00:00
...and even source code
```
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}