hugo-theme-relearn/exampleSite/content/shortcodes/expand.en.md

92 lines
1.8 KiB
Markdown
Raw Normal View History

2017-08-20 15:10:29 +00:00
---
title : Expand
description : "Displays an expandable/collapsible section of text on your page"
---
The Expand shortcode displays an expandable/collapsible section of text on your page.
2021-07-16 20:35:20 +00:00
## Usage
````
{{%/* expand "Does this relearn theme rock?" { "true" | "false" } */%}}
2021-07-16 20:35:20 +00:00
Yes!
{{%/* /expand */%}}
2021-07-16 20:35:20 +00:00
````
The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is `"Expand me..."`.
2021-07-16 20:35:20 +00:00
The second optional parameter controls if the block is initially shown as expanded (`"true"`) or collapsed (`"false"`). The default ist `"false"`.
2021-07-16 20:35:20 +00:00
## Examples
### All defaults
2017-08-20 15:10:29 +00:00
{{% expand %}}
Yes, you did it!
{{% /expand %}}
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" "true" %}}
2021-07-16 20:35:20 +00:00
````
{{%/* expand */%}}
Yes, you did it!
2021-07-16 20:35:20 +00:00
{{%/* /expand */%}}
````
{{% /expand %}}
### Initially expanded
{{% expand "Expand me..." "true" %}}
No need to press you!
{{% /expand %}}
{{% expand "Show markup" "true" %}}
````
{{%/* expand "Expand me..." "true" */%}}
No need to press you!
{{%/* /expand */%}}
````
{{% /expand %}}
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
### Arbitrary text
2017-08-20 15:10:29 +00:00
{{% expand "Show me endless possibilities" %}}
2021-07-16 20:35:20 +00:00
Some expandable text.
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
You can add:
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text
2021-07-16 20:35:20 +00:00
- [links](https://example.com)
- other shortcodes besides `expand`
- etc.
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
```
...and even source code
```
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
> the possiblities are endless
{{% /expand %}}
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
{{% expand "Show markup" %}}
````
{{%/* expand "Show me endless possibilities" */%}}
Some expandable text.
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
You can add:
2017-08-20 15:10:29 +00:00
2021-07-16 20:35:20 +00:00
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** and even **_bold emphasized_** text
2021-07-16 20:35:20 +00:00
- [links](https://example.com)
- other shortcodes besides `expand`
- etc.
```
...and even source code
```
> the possiblities are endless
{{%/* /expand */%}}
````
{{% /expand %}}