From 5ef497a2897d884c57d9294875572cce53a9a43e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Mon, 23 May 2022 14:59:24 +0200 Subject: [PATCH] docs: clarify usage of shortcodes in included content #245 --- exampleSite/content/shortcodes/INCLUDE_ME.md | 5 +-- exampleSite/content/shortcodes/expand.en.md | 14 +++---- exampleSite/content/shortcodes/notice.en.md | 40 ++++++++------------ 3 files changed, 24 insertions(+), 35 deletions(-) diff --git a/exampleSite/content/shortcodes/INCLUDE_ME.md b/exampleSite/content/shortcodes/INCLUDE_ME.md index 65e40df612..2953e0c96d 100644 --- a/exampleSite/content/shortcodes/INCLUDE_ME.md +++ b/exampleSite/content/shortcodes/INCLUDE_ME.md @@ -1,14 +1,13 @@ -You can add: +You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) -- other shortcodes besides `include` - etc. ```plaintext ...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) diff --git a/exampleSite/content/shortcodes/expand.en.md b/exampleSite/content/shortcodes/expand.en.md index 4d991c585c..a162742337 100644 --- a/exampleSite/content/shortcodes/expand.en.md +++ b/exampleSite/content/shortcodes/expand.en.md @@ -52,44 +52,42 @@ No need to press you! ### Arbitrary text -{{% expand "Show me endless possibilities" %}} +{{% expand "Show me almost endless possibilities" %}} Some expandable text. -You can add: +You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) -- other shortcodes besides `expand` - etc. ```plaintext ...and even source code ``` -> the possiblities are endless +> the possiblities are endless (almost - including other shortcodes may or may not work) {{% /expand %}} {{% expand "Show markup" %}} ````go -{{%/* expand "Show me endless possibilities" */%}} +{{%/* expand "Show me almost endless possibilities" */%}} Some expandable text. -You can add: +You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) -- other shortcodes besides `expand` - etc. ```plaintext ...and even source code ``` -> the possiblities are endless +> the possiblities are endless (almost - including other shortcodes may or may not work) {{%/* /expand */%}} ```` {{% /expand %}} diff --git a/exampleSite/content/shortcodes/notice.en.md b/exampleSite/content/shortcodes/notice.en.md index c69d424598..957de7c57c 100644 --- a/exampleSite/content/shortcodes/notice.en.md +++ b/exampleSite/content/shortcodes/notice.en.md @@ -25,20 +25,19 @@ The third parameter is optional. If provided, it will set the icon of near the t {{% notice note %}} A **notice** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} {{% expand "Show markup" %}} @@ -46,20 +45,19 @@ You can add: {{%/* notice note */%}} A **notice** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{%/* /notice */%}} ```` {{% /expand %}} @@ -69,20 +67,19 @@ You can add: {{% notice info %}} An **information** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} {{% expand "Show markup" %}} @@ -90,20 +87,19 @@ You can add: {{%/* notice info */%}} An **information** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{%/* /notice */%}} ```` {{% /expand %}} @@ -113,20 +109,19 @@ You can add: {{% notice tip %}} A **tip** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} {{% expand "Show markup" %}} @@ -134,20 +129,19 @@ You can add: {{%/* notice tip */%}} A **tip** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{%/* /notice */%}} ```` {{% /expand %}} @@ -157,20 +151,19 @@ You can add: {{% notice warning %}} A **warning** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} {{% expand "Show markup" %}} @@ -178,20 +171,19 @@ You can add: {{%/* notice warning */%}} A **warning** disclaimer -You can add: +You can add standard markdown syntax: - 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 +> the possiblities are endless (almost - including other shortcodes may or may not work) {{%/* /notice */%}} ```` {{% /expand %}}