You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using the `banner` field in your frontmatter, you cannot use the `usestatic` shortcode. You must provide the full, static path to the image, starting with your OrganizationUUID.
152
+
When using the `banner` field in your frontmatter, always provide the full, static path to your image. This path must start with your OrganizationUUID; for example: `/org_id/images/kubernetes-icon.svg`.
153
153
{{< /alert >}}
154
154
155
155
> For a complete list of all predefined variables and advanced usage, please refer to the official [Hugo FrontMatter documentation](https://gohugo.io/content-management/front-matter/).
156
156
157
157
## 3. AddAssets and InteractiveContent
158
158
159
-
Enhance your course with images and other visual aids. To ensure compatibility with the multi-tenant Academy platform, do not use standard Markdownimage links. Instead, use the `usestatic` shortcode, which generates the correct, tenant-aware path for your assets.
159
+
Enhance your course with images and other visual aids. The recommended and standard method for adding images is PageBundling. This approach involves placing your image files directly alongside the Markdown content they belong to, which is simpler and keeps content organized.
160
160
161
-
{{< alert type="warning" title="Do Not Use Standard Markdown Image Links" >}}
162
-
Do not use standard Markdown image links. Always use the `usestatic` shortcode for images to ensure compatibility with the platform.
2. In your `Chapter-1.md` file, embed the image using the `usestatic` shortcode. The`path` is relative to your scoped static folder:
169
+
2. In your `Chapter-1.md` file, embed the image using a **standard Markdown link**. The path should just be the filename.
173
170
174
-
```text
175
-

171
+
```markdown
172
+

176
173
```
177
174
178
-
Then the system will automatically convert this into the correct URL when building the site.
175
+
{{< alert type="warning" title="Legacy Method: Do Not Use" >}}
176
+
The `usestatic` shortcode is **deprecated** and should not be used for new courses.
177
+
{{< /alert >}}
179
178
180
179
**How to Add a Video**
181
180
@@ -189,10 +188,6 @@ title="Video: Example" */>}}
189
188
{{</* /card */>}}
190
189
```
191
190
192
-
{{< alert type="info" title="Best Practice" >}}
193
-
If your images are only needed for a specific chapter or section (not globally), it is recommended to place them next to the relevant content folder. This keeps your project organized and makes asset management easier.
194
-
{{< /alert >}}
195
-
196
191
## 4. Build and PreviewLocally
197
192
198
193
Before publishing, it is crucial to preview your content locally to check for formatting errors, broken links, and overall structure.
0 commit comments