nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: adjust notice doc to shortcode standard #240

Browse source
This commit is contained in:
Sören Weber 2022-06-07 20:30:07 +02:00
parent cc08c9f3df
commit ac42869c28
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
1 changed files with 54 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -48,26 +48,6 @@ It is all about the boxes.
#### Info with markup #### Info with markup
{{% notice style="info" %}}
An **information** disclaimer
You can add standard markdown syntax:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com)
- etc.
```plaintext
...and even source code
```
> the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}}
{{% expand "Show markup" %}}
````go ````go
{{%/* notice style="info" */%}} {{%/* notice style="info" */%}}
An **information** disclaimer An **information** disclaimer
@ -88,15 +68,25 @@ You can add standard markdown syntax:
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="info" %}}
An **information** disclaimer
#### Note You can add standard markdown syntax:
{{% notice style="note" %}} - multiple paragraphs
A **notice** disclaimer - bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com)
- etc.
```plaintext
...and even source code
```
> the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Note
````go ````go
{{%/* notice style="note" */%}} {{%/* notice style="note" */%}}
@ -104,30 +94,22 @@ A **notice** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="note" %}}
A **notice** disclaimer
#### Tip
{{% notice style="tip" %}}
A **tip** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Tip
````go ````go
{{%/* notice style="tip" */%}} {{%/* notice style="tip" */%}}
A **tip** disclaimer A **tip** disclaimer
```` ````
{{% /expand %}} {{% notice style="tip" %}}
A **tip** disclaimer
#### Warning
{{% notice style="warning" %}}
A **warning** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Warning
````go ````go
{{%/* notice style="warning" */%}} {{%/* notice style="warning" */%}}
@ -135,15 +117,11 @@ A **warning** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="warning" %}}
#### Warning with Non-Default Title and Icon
{{% notice style="warning" title="Here are dragons" icon="dragon" %}}
A **warning** disclaimer A **warning** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Warning with Non-Default Title and Icon
````go ````go
{{%/* notice style="warning" title="Here are dragons" icon="dragon" */%}} {{%/* notice style="warning" title="Here are dragons" icon="dragon" */%}}
@ -151,15 +129,11 @@ A **warning** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="warning" title="Here are dragons" icon="dragon" %}}
#### Warning without a Title and Icon
{{% notice style="warning" title=" " icon=" " %}}
A **warning** disclaimer A **warning** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Warning without a Title and Icon
````go ````go
{{%/* notice style="warning" title=" " icon=" " */%}} {{%/* notice style="warning" title=" " icon=" " */%}}
@ -167,33 +141,25 @@ A **warning** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="warning" title=" " icon=" " %}}
A **warning** disclaimer
{{% /notice %}}
### By Brand Colors ### By Brand Colors
#### Primary with Title only #### Primary with Title only
{{% notice style="primary" title="Primary" %}}
A **primary** disclaimer
{{% /notice %}}
{{% expand "Show markup" %}}
````go ````go
{{%/* notice style="primary" title="Primary" */%}} {{%/* notice style="primary" title="Primary" */%}}
A **primary** disclaimer A **primary** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="primary" title="Primary" %}}
A **primary** disclaimer
#### Secondary with Icon only
{{% notice style="secondary" icon="stopwatch" %}}
A **secondary** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Secondary with Icon only
````go ````go
{{%/* notice style="secondary" icon="stopwatch" */%}} {{%/* notice style="secondary" icon="stopwatch" */%}}
@ -201,33 +167,25 @@ A **secondary** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="secondary" icon="stopwatch" %}}
A **secondary** disclaimer
{{% /notice %}}
### By Color ### By Color
#### Blue without a Title and Icon #### Blue without a Title and Icon
{{% notice style="blue" %}}
A **blue** disclaimer
{{% /notice %}}
{{% expand "Show markup" %}}
````go ````go
{{%/* notice style="blue" */%}} {{%/* notice style="blue" */%}}
A **blue** disclaimer A **blue** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="blue" %}}
A **blue** disclaimer
#### Green with Title only
{{% notice style="green" title="Green" %}}
A **green** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Green with Title only
````go ````go
{{%/* notice style="green" title="Green" */%}} {{%/* notice style="green" title="Green" */%}}
@ -235,15 +193,11 @@ A **green** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="green" title="Green" %}}
A **green** disclaimer
#### Grey with Icon only
{{% notice style="grey" icon="bug" %}}
A **grey** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Grey with Icon only
````go ````go
{{%/* notice style="grey" icon="bug" */%}} {{%/* notice style="grey" icon="bug" */%}}
@ -251,15 +205,11 @@ A **grey** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="grey" icon="bug" %}}
A **grey** disclaimer
#### Orange with Title and Icon
{{% notice style="orange" title="Orange" icon="bug" %}}
A **orange** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Orange with Title and Icon
````go ````go
{{%/* notice style="orange" title="Orange" icon="bug" */%}} {{%/* notice style="orange" title="Orange" icon="bug" */%}}
@ -267,15 +217,11 @@ A **orange** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="orange" title="Orange" icon="bug" %}}
A **orange** disclaimer
#### Red
{{% notice style="red" %}}
A **red** disclaimer
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Red
````go ````go
{{%/* notice style="red" */%}} {{%/* notice style="red" */%}}
@ -283,33 +229,25 @@ A **red** disclaimer
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="red" %}}
A **red** disclaimer
{{% /notice %}}
### By Special Color ### By Special Color
#### Default with Title and Icon #### Default with Title and Icon
{{% notice default "Pay Attention to this Note!" "skull-crossbones" %}}
Some serious information.
{{% /notice %}}
{{% expand "Show markup" %}}
````go ````go
{{%/* notice style="default" title"Pay Attention to this Note!" icon="skull-crossbones" */%}} {{%/* notice style="default" title"Pay Attention to this Note!" icon="skull-crossbones" */%}}
Some serious information. Some serious information.
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice default "Pay Attention to this Note!" "skull-crossbones" %}}
#### Transparent with Title and Icon
{{% notice style="transparent" title="Pay Attention to this Note!" icon="skull-crossbones" %}}
Some serious information. Some serious information.
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} #### Transparent with Title and Icon
````go ````go
{{%/* notice style="transparent" title"Pay Attention to this Note!" icon="skull-crossbones" */%}} {{%/* notice style="transparent" title"Pay Attention to this Note!" icon="skull-crossbones" */%}}
@ -317,4 +255,6 @@ Some serious information.
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% notice style="transparent" title="Pay Attention to this Note!" icon="skull-crossbones" %}}
Some serious information.
{{% /notice %}}