docs: add documentation on all shortcodes (#753)

2025-08-15 03:09:58 +02:00
parent 80ada64da0
commit 2033d50005
22 changed files with 222 additions and 6 deletions
--- a/layouts/_shortcodes/pdf.html
+++ b/layouts/_shortcodes/pdf.html
@@ -1,4 +1,10 @@
-{{/* Shortcode to include a PDF file in a page. */}}
+{{- /*
+Shortcode to include a PDF file in a page.
+
+@param {string} 0 The path to the PDF file.
+
+@example {{< pdf "path/to/file.pdf" >}}
+*/ -}}

 {{- $path := .Get 0 -}}
 {{- $url := partial "utils/file-path" (dict "page" .Page "path" $path) -}}