mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 10:43:19 +00:00
42c8ec549b
The new highlighter does not work to well if no syntax is specified for the code block / code fence / indention. See https://github.com/gohugoio/hugo/pull/8917
192 lines
3.1 KiB
Markdown
192 lines
3.1 KiB
Markdown
---
|
|
title: Notice
|
|
description: "Disclaimers to help you structure your page"
|
|
---
|
|
|
|
The notice shortcode shows four types of disclaimers to help you structure your page.
|
|
|
|
## Usage
|
|
|
|
````go
|
|
{{%/* notice [ note | info | tip | warning ] */%}}
|
|
Some markup
|
|
{{%/* /notice */%}}
|
|
````
|
|
|
|
## Examples
|
|
|
|
### Note
|
|
|
|
{{% notice note %}}
|
|
A **notice** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{% /notice %}}
|
|
|
|
{{% expand "Show markup" %}}
|
|
````go
|
|
{{%/* notice note */%}}
|
|
A **notice** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{%/* /notice */%}}
|
|
````
|
|
{{% /expand %}}
|
|
|
|
### Info
|
|
|
|
{{% notice info %}}
|
|
An **information** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{% /notice %}}
|
|
|
|
{{% expand "Show markup" %}}
|
|
````go
|
|
{{%/* notice info */%}}
|
|
An **information** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{%/* /notice */%}}
|
|
````
|
|
{{% /expand %}}
|
|
|
|
### Tip
|
|
|
|
{{% notice tip %}}
|
|
A **tip** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{% /notice %}}
|
|
|
|
{{% expand "Show markup" %}}
|
|
````go
|
|
{{%/* notice tip */%}}
|
|
A **tip** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{%/* /notice */%}}
|
|
````
|
|
{{% /expand %}}
|
|
|
|
### Warning
|
|
|
|
{{% notice warning %}}
|
|
A **warning** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{% /notice %}}
|
|
|
|
{{% expand "Show markup" %}}
|
|
````go
|
|
{{%/* notice warning */%}}
|
|
A **warning** disclaimer
|
|
|
|
You can add:
|
|
|
|
- multiple paragraphs
|
|
- bullet point lists
|
|
- _emphasized_, **bold** and even ***bold emphasized*** text
|
|
- [links](https://example.com)
|
|
- other shortcodes besides `notice`
|
|
- etc.
|
|
|
|
```plaintext
|
|
...and even source code
|
|
```
|
|
|
|
> the possiblities are endless
|
|
{{%/* /notice */%}}
|
|
````
|
|
{{% /expand %}}
|