summaryrefslogtreecommitdiffstats
path: root/CONTENT_GUIDE.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-04-05 09:38:47 +0200
committerDanilo M. <danix@danix.xyz>2026-04-05 09:38:47 +0200
commit7de9682e8f3d6a1a6819c1a26c332ff72dbeaaa4 (patch)
tree684e8042f3f36e0a132b9be09ff84fefd0fd2563 /CONTENT_GUIDE.md
parentfcf2f6f50ce06e9d2e8e49b7a3c1095169a43076 (diff)
downloaddanixxyz-theme-7de9682e8f3d6a1a6819c1a26c332ff72dbeaaa4.tar.gz
danixxyz-theme-7de9682e8f3d6a1a6819c1a26c332ff72dbeaaa4.zip
feat: add video shortcode and documentation
Ported video shortcode from previous theme. Embeds HTML5 videos with optional autoplay, loop, and muted controls. Supports mp4, webm, and other HTML5 video formats. Usage: {{< video src="video.mp4" width=800 height=450 autoplay=true loop=true muted=true >}} Also updated CONTENT_GUIDE with comprehensive usage examples and parameters. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Diffstat (limited to 'CONTENT_GUIDE.md')
-rw-r--r--CONTENT_GUIDE.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/CONTENT_GUIDE.md b/CONTENT_GUIDE.md
index 834a8f4..b071166 100644
--- a/CONTENT_GUIDE.md
+++ b/CONTENT_GUIDE.md
@@ -624,6 +624,45 @@ Figure with clickable link:
---
+### Video Shortcode
+
+The `video` shortcode embeds HTML5 videos with controls, optional autoplay, looping, and muting. Supports mp4, webm, and other HTML5 video formats.
+
+**Usage:**
+```hugo
+{{< video src="my-video.mp4" width=600 height=400 >}}
+```
+
+**Parameters:**
+- `src` (required) — Path to video file (mp4, webm, etc.)
+- `width` (optional) — Video width in pixels
+- `height` (optional) — Video height in pixels
+- `autoplay` (optional) — true/false (default: false)
+- `loop` (optional) — true/false (default: false)
+- `muted` (optional) — true/false (default: false)
+- `class` (optional) — CSS class for styling
+
+**Note:** The `muted` attribute is often required for autoplay to work in modern browsers.
+
+**Examples:**
+
+Simple video with controls:
+```hugo
+{{< video src="demo.mp4" width=800 height=450 >}}
+```
+
+Auto-looping muted video (useful for GIF-like effects):
+```hugo
+{{< video src="animation.mp4" width=640 height=480 autoplay=true loop=true muted=true >}}
+```
+
+Styled video with custom class:
+```hugo
+{{< video src="tutorial.webm" width=1024 height=576 class="responsive-video" >}}
+```
+
+---
+
## Troubleshooting
### Article doesn't appear on site