nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 19:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

notice: rework documentation

Browse source
This commit is contained in:
Sören Weber 2021-07-16 22:04:22 +02:00
parent f66e1bf576
commit 86317356d6
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
1 changed files with 166 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

207
exampleSite/content/shortcodes/notice.en.md
View file

@ -1,66 +1,191 @@
---
title: Notice
description : "Disclaimers to help you structure your page"
description: "Disclaimers to help you structure your page"
---
The notice shortcode shows 4 types of 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
With multiple paragraphs
{{%/* /notice */%}}
```
renders as
{{% notice note %}}
A notice disclaimer
A **notice** disclaimer
With multiple paragraphs
You can add:
- multiple paragraphs
- bullet point lists
- *emphasized*, **bold** and even ***bold emphasized*** text
- [links](https://example.com)
- other shortcodes besides `notice`
- etc.
```
...and even source code
```
> the possiblities are endless
{{% /notice %}}
{{% expand Code %}}
````
{{%/* 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.
```
...and even source code
```
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Info
```
{{%/* notice info */%}}
An information disclaimer
{{%/* /notice */%}}
```
renders as
{{% notice info %}}
An information disclaimer
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.
```
...and even source code
```
> the possiblities are endless
{{% /notice %}}
{{% expand Code %}}
````
{{%/* 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.
```
...and even source code
```
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Tip
```
{{%/* notice tip */%}}
A tip disclaimer
{{%/* /notice */%}}
```
renders as
{{% notice tip %}}
A tip disclaimer
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.
```
...and even source code
```
> the possiblities are endless
{{% /notice %}}
{{% expand Code %}}
````
{{%/* 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.
```
...and even source code
```
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}
### Warning
```
{{%/* notice warning */%}}
A warning disclaimer
{{%/* /notice */%}}
```
renders as
{{% notice warning %}}
A warning disclaimer
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.
```
...and even source code
```
> the possiblities are endless
{{% /notice %}}
{{% expand Code %}}
````
{{%/* 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.
```
...and even source code
```
> the possiblities are endless
{{%/* /notice */%}}
````
{{% /expand %}}