From 1207bebadda55fd894b663732efc4e6670d54ca2 Mon Sep 17 00:00:00 2001
From: weru <fromweru@gmail.com>
Date: Wed, 10 Feb 2021 16:46:57 +0000
Subject: [PATCH] edit page
---
exampleSite/content/docs/compose/shortcodes.md | 68 +++++++++++++++++++++++++++++++---
1 files changed, 62 insertions(+), 6 deletions(-)
diff --git a/exampleSite/content/docs/compose/shortcodes.md b/exampleSite/content/docs/compose/shortcodes.md
index 1911576..0f30e5c 100644
--- a/exampleSite/content/docs/compose/shortcodes.md
+++ b/exampleSite/content/docs/compose/shortcodes.md
@@ -38,17 +38,21 @@
{{</* /column */>}}
```
-### Video
+### Youtube Video
This allows you to embed a youtube video in you content. You would achieve that using a positional parameter (needs no name )parameter, like so:
-**Example:**
+__Syntax__
```markdown
- {{</* youtube "xWF59rWSceA" */>}}
+ {{</* youtube "25QyCxVkXwQ" */>}}
<!-- Use the youtube video id -->
```
+__Result__
+
+{{< youtube "25QyCxVkXwQ" >}}
+
### Button
This adds a styled link (styled like a button). It takes two no-optional parameters:
@@ -61,7 +65,7 @@
**Example**
-```
+```markdown
{{</* button "/" "doe nu mee" */>}}
```
@@ -71,12 +75,18 @@
Store these images in the `static/images` directory.
-```sh
+__Syntax__
+
+```markdown
...
{{</* picture "lightModeImage.png" "darkModeImage.png" "Image alt text" */>}}
...
```
+__Result__
+
+{{< picture "compose.svg" "compose-light.svg" "Compose Logo" >}}
+
### Gallery
Include inline galleries within your articles. These galleries can contain `N` number of images. It takes 2 positional parameters.
@@ -85,8 +95,54 @@
The 2nd parameter is optional. It's a _double-collon-separated list_ (`::`) of your images' alt/description/captions text. It's always a good SEO practice to include alt text for your images.
-```sh
+__Syntax__
+
+```markdown
...
{{</* gallery "images/painting.jpg,images/scribble.jpg,images/painting.jpg" "Gallery Image 1::gallery image 2::gallery image 1 copy" */>}}
...
```
+{{< tip >}}
+> For legibility, you may include a space after the delimiters `,` & `::`
+{{< /tip >}}
+
+__Result__
+
+{{< gallery "images/painting.jpg,images/scribble.jpg,images/painting.jpg" "Gallery Image 1::gallery image 2::gallery image 1 copy" >}}
+
+
+### Tip
+
+Use this short if you want to publish informational tooltips that look like:
+
+This tooltips may take either of the following forms:
+
+__Syntax__
+
+```markdown
+{{</* tip */>}}
+Something of __interest__ you want to highlight
+{{</* /tip */>}}
+```
+
+__Result__
+
+{{< tip >}}
+Something of __interest__ you want to highlight
+{{< /tip >}}
+
+__OR__
+
+__Syntax__
+
+```markdown
+{{</* tip "warning" */>}}
+Something of __interest__ the user should be careful about
+{{</* /tip */>}}
+```
+
+__Result__
+
+{{< tip "warning" >}}
+Something of __interest__ the user should be careful about
+{{< /tip >}}
--
Gitblit v1.10.0