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

docs: clarify usage of shortcodes in included content #245

Browse source
This commit is contained in:
Sören Weber 2022-05-23 14:59:24 +02:00
parent 4350348123
commit 5ef497a289
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
3 changed files with 24 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
exampleSite/content/shortcodes/INCLUDE_ME.md
View file

@ -1,14 +1,13 @@
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text - _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `include`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)

14
exampleSite/content/shortcodes/expand.en.md
View file

@ -52,44 +52,42 @@ No need to press you!
### Arbitrary text ### Arbitrary text
{{% expand "Show me endless possibilities" %}} {{% expand "Show me almost endless possibilities" %}}
Some expandable text. Some expandable text.
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text - _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `expand`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /expand %}} {{% /expand %}}
{{% expand "Show markup" %}} {{% expand "Show markup" %}}
````go ````go
{{%/* expand "Show me endless possibilities" */%}} {{%/* expand "Show me almost endless possibilities" */%}}
Some expandable text. Some expandable text.
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text - _emphasized_, **bold** and even **_bold emphasized_** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `expand`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /expand */%}} {{%/* /expand */%}}
```` ````
{{% /expand %}} {{% /expand %}}

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

@ -25,20 +25,19 @@ The third parameter is optional. If provided, it will set the icon of near the t
{{% notice note %}} {{% notice note %}}
A **notice** disclaimer A **notice** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} {{% expand "Show markup" %}}
@ -46,20 +45,19 @@ You can add:
{{%/* notice note */%}} {{%/* notice note */%}}
A **notice** disclaimer A **notice** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% /expand %}}
@ -69,20 +67,19 @@ You can add:
{{% notice info %}} {{% notice info %}}
An **information** disclaimer An **information** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} {{% expand "Show markup" %}}
@ -90,20 +87,19 @@ You can add:
{{%/* notice info */%}} {{%/* notice info */%}}
An **information** disclaimer An **information** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% /expand %}}
@ -113,20 +109,19 @@ You can add:
{{% notice tip %}} {{% notice tip %}}
A **tip** disclaimer A **tip** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} {{% expand "Show markup" %}}
@ -134,20 +129,19 @@ You can add:
{{%/* notice tip */%}} {{%/* notice tip */%}}
A **tip** disclaimer A **tip** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% /expand %}}
@ -157,20 +151,19 @@ You can add:
{{% notice warning %}} {{% notice warning %}}
A **warning** disclaimer A **warning** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{% /notice %}} {{% /notice %}}
{{% expand "Show markup" %}} {{% expand "Show markup" %}}
@ -178,20 +171,19 @@ You can add:
{{%/* notice warning */%}} {{%/* notice warning */%}}
A **warning** disclaimer A **warning** disclaimer
You can add: You can add standard markdown syntax:
- multiple paragraphs - multiple paragraphs
- bullet point lists - bullet point lists
- _emphasized_, **bold** and even ***bold emphasized*** text - _emphasized_, **bold** and even ***bold emphasized*** text
- [links](https://example.com) - [links](https://example.com)
- other shortcodes besides `notice`
- etc. - etc.
```plaintext ```plaintext
...and even source code ...and even source code
``` ```
> the possiblities are endless > the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /notice */%}} {{%/* /notice */%}}
```` ````
{{% /expand %}} {{% /expand %}}