File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff 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
3941When you clone the template, you’ll see a familiar Hugo structure:
@@ -101,3 +103,70 @@ learning-paths/
101103```
102104
103105Each ` _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+ ``` gohtml
122+ {{< usestatic path="images/logo.png" >}}
123+ ```
124+
125+ ### 🧠 What it does
126+
127+ This will generate a URL like:
128+
129+ ``` html
130+ /static/<tenant-uuid >/images/logo.png
131+ ```
132+
133+ Where ` <tenant-uuid> ` comes from your ` tenant-context.html ` partial.
134+
135+ ### 📎 Example
136+
137+ ``` markdown
138+ ![ Logo] ({{< usestatic path="images/logo.png" >}})
139+ ```
140+
141+ Rendered as:
142+
143+ ``` html
144+ <img src =" /static/acme-org-uuid/images/logo.png" alt =" Logo" >
145+ ```
146+
147+ ---
148+
149+ ## 🔒 Why these are useful
150+
151+ These shortcodes:
152+
153+ * Eliminate the need to repeat or hardcode tenant UUIDs
154+ * Keep content files clean and user-friendly
155+ * Enable reuse of global shortcodes/themes across isolated tenants
156+
157+ ---
158+
159+ ## 🌐 Example Directory Layout
160+
161+ ```
162+ layouts/
163+ ├── shortcodes/
164+ │ └── acme-org-uuid/
165+ │ └── banner.html
166+ static/
167+ └── acme-org-uuid/
168+ └── images/
169+ └── logo.png
170+ ```
171+
172+ ---
You can’t perform that action at this time.
0 commit comments