Skip to content

Commit c47addb

Browse files
authored
Enhance shortcode instructions with example link
Updated the shortcode creation steps with an example link and clarified the file path format. Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
1 parent 755ea29 commit c47addb

File tree

1 file changed

+6
-3
lines changed
  • content/en/cloud/academy/creating-content/extending-the-academy

1 file changed

+6
-3
lines changed

content/en/cloud/academy/creating-content/extending-the-academy/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,14 @@ Custom shortcodes are reusable components that enhance Academy content. They fun
9999

100100
##### Basic Shortcode
101101

102-
**Step 1:** Create the shortcode file in your organization's directory:
103-
```
102+
**Step 1:** Create the shortcode file in your organization's directory ([example](https://github.com/layer5io/academy-example/tree/master/layouts)):
103+
104+
```shell
104105
layouts/shortcodes/<your-organization-uuid>/custom-org-shortcode.html
105106
```
106107

107108
**Step 2:** Define the shortcode template:
109+
108110
```html
109111
{{ $names := .Get "names" }}
110112
<div class="custom shortcode">
@@ -114,6 +116,7 @@ layouts/shortcodes/<your-organization-uuid>/custom-org-shortcode.html
114116
```
115117

116118
**Step 3:** Use the shortcode in your content:
119+
117120
```markdown
118121
{{< custom-org-shortcode names="Alex, Bob, Charely" >}}
119122
```
@@ -199,4 +202,4 @@ When users click the badge, they will go to the details in the Academy:
199202

200203
{{< alert type="info" title="Email Customization" >}}
201204
Email templates automatically incorporate your organization's logo and primary brand color as configured in your [Layer5 Cloud Organization Settings](https://cloud.layer5.io/identity/organizations). Custom email templates can be provided for Enterprise customers with specific branding requirements.
202-
{{< /alert >}}
205+
{{< /alert >}}

0 commit comments

Comments
 (0)