chore: describe image options

charlesrocket · Jan 23, 2024 · 636019b · 636019b
1 parent 8b7b779
commit 636019b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/content/posts/image/index.md b/content/posts/image/index.md
@@ -9,14 +9,16 @@ subtitle = "Shortcodes for images"
 csp_img = ["raw.githubusercontent.com/charlesrocket/beastie/"]
 +++
 
-All variables (except `img`) are optional.
-
 input:
 
 ```rs
 {{/* image(img="fireball.gif", link="https://halve-z.netlify.app/", alt="Fireball", caption="8bit fireball") */}}
 ```
 
+- `img`: the source string (mandatory)
+- `caption`: set image caption (optional)
+- `alt`: set alternative text (optional)
+
 output:
 
 ```html