hugo-theme-relearn/exampleSite/content/shortcodes/notice.en.md
Sören Weber 42c8ec549b
code highlighter: avoid unstyled blocks in docs #32
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
2021-08-23 23:32:34 +02:00

3.1 KiB

title description
Notice Disclaimers to help you structure your page

The notice shortcode shows four types of disclaimers to help you structure your page.

Usage

{{%/* 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
  • other shortcodes besides notice
  • etc.
...and even source code

the possiblities are endless {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* 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
  • other shortcodes besides notice
  • etc.
...and even source code

the possiblities are endless {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* 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
  • other shortcodes besides notice
  • etc.
...and even source code

the possiblities are endless {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* 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
  • other shortcodes besides notice
  • etc.
...and even source code

the possiblities are endless {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* 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 %}}