@@ -49,17 +49,21 @@ Control how code blocks are displayed vs rendered using attributes:
4949
5050#### Rendering Typst Outputs
5151
52- To generate PNG images for Typst code blocks marked with ` {.render} ` or ` {.side-by-side} ` :
52+ ** IMPORTANT: Typst rendering MUST be done locally before pushing to GitHub.**
53+
54+ GitHub Actions does NOT render Typst files. You must generate and commit the PNG outputs locally.
55+
56+ To generate PNG/PDF files for Typst code blocks marked with ` {.render} ` or ` {.side-by-side} ` :
5357
5458``` bash
5559bash scripts/render-typst.sh
5660```
5761
5862This script will:
5963- Scan all markdown files for Typst code blocks that need rendering
60- - Compile them using the Typst CLI to PNG images
61- - Save outputs to ` static/rendered/typst/{page-slug}/typst-{hash}.png `
62- - Cache previously rendered images (won't re-render if unchanged)
64+ - Compile them using the Typst CLI to PNG or PDF files (PDF for multi-page documents)
65+ - Save outputs to ` static/rendered/typst/{page-slug}/typst-{hash}.png ` or ` .pdf `
66+ - Cache previously rendered files (won't re-render if unchanged)
6367
6468## Content Publishing Workflow
6569
@@ -71,7 +75,7 @@ This script will:
7175 # Edit the file, add Typst code blocks with {.render} or {.side-by-side}
7276 ```
7377
74- 2 . ** Generate Typst PNG outputs:**
78+ 2 . ** Generate Typst PNG/PDF outputs:**
7579 ``` bash
7680 bash scripts/render-typst.sh
7781 ```
@@ -97,7 +101,8 @@ This script will:
971013 . Commit and push
98102
99103### Important Notes:
100- - ** Always commit the generated PNG files** - They must be in the repository for GitHub Pages to serve them
104+ - ** REQUIRED: Render Typst locally before pushing** - GitHub Actions does NOT have Typst installed
105+ - ** Always commit the generated PNG/PDF files** - They must be in the repository for GitHub Pages to serve them
101106- The render script uses caching - only re-renders changed content
102107- Raw Typst code blocks (` ```typst ` ) don't need the script, they just show syntax-highlighted code
103108- Mermaid diagrams work without scripts (rendered client-side)
0 commit comments