Skip to content

Commit b2affb1

Browse files
authored
Merge pull request #684 from layer5io/academy-dcs
update docs
2 parents a5138eb + 7b5ed6b commit b2affb1

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

content/en/cloud/academy/extending-academy.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Content is sourced using the **[Hugo](https://gohugo.io/)** static site engine.
3434
3535
---
3636

37+
38+
3739
## Directory Overview
3840

3941
When you clone the template, you’ll see a familiar Hugo structure:
@@ -101,3 +103,66 @@ learning-paths/
101103
```
102104

103105
Each `_index.md` file contains frontmatter and overview content for that level (path, course, chapter).
106+
107+
108+
## Available Shortcodes
109+
110+
111+
112+
Your theme includes powerful utility shortcodes that abstract away tenant scoping and other content rendering
113+
114+
115+
## 🖼️ `usestatic` – Tenant-scoped static file helper
116+
117+
**Use when you want to include static assets under a tenant-specific path.**
118+
119+
### ✅ Syntax
120+
121+
{{</* usestatic path="images/logo.png" */>}}
122+
123+
### 🧠 What it does
124+
125+
This will generate a URL like:
126+
127+
```html
128+
/static/<tenant-uuid>/images/logo.png
129+
```
130+
131+
Where `<tenant-uuid>` comes from your `tenant-context.html` partial.
132+
133+
### 📎 Example
134+
135+
![Logo]({{</* usestatic path="images/logo.png" */>}})
136+
137+
Rendered as:
138+
139+
```html
140+
<img src="/static/acme-org-uuid/images/logo.png" alt="Logo">
141+
```
142+
143+
---
144+
145+
## 🔒 Why these are useful
146+
147+
These shortcodes:
148+
149+
* Eliminate the need to repeat or hardcode tenant UUIDs
150+
* Keep content files clean and user-friendly
151+
* Enable reuse of global shortcodes/themes across isolated tenants
152+
153+
---
154+
155+
## 🌐 Example Directory Layout
156+
157+
```
158+
layouts/
159+
├── shortcodes/
160+
│ └── acme-org-uuid/
161+
│ └── banner.html
162+
static/
163+
└── acme-org-uuid/
164+
└── images/
165+
└── logo.png
166+
```
167+
168+
---

0 commit comments

Comments
 (0)