Skip to content

Commit dc4fd5e

Browse files
committed
v3.0.2 ready
1 parent 6ef2ae7 commit dc4fd5e

File tree

4 files changed

+22
-28
lines changed

4 files changed

+22
-28
lines changed

.changes/v3.0.2.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## v3.0.2 - 2025-10-01
2+
### Changed
3+
* README updated to reflect changes to GitHub actions
4+
### Removed
5+
* rust and `typst` install on GitHub actions

.github/workflows/hugo.yml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,6 @@ jobs:
4444
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
4545
- name: Install Dart Sass
4646
run: sudo snap install dart-sass
47-
- name: Install Rust and Typst
48-
run: |
49-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
50-
source "$HOME/.cargo/env"
51-
cargo install --locked typst-cli
52-
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
53-
- name: Render Typst code blocks
54-
run: |
55-
if [ -f scripts/render-typst.sh ]; then
56-
bash scripts/render-typst.sh
57-
fi
5847
- name: Build with Hugo (panic on warnings)
5948
env:
6049
HUGO_ENVIRONMENT: production
@@ -73,12 +62,6 @@ jobs:
7362
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
7463
- name: Install Dart Sass
7564
run: sudo snap install dart-sass
76-
- name: Install Rust and Typst
77-
run: |
78-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
79-
source "$HOME/.cargo/env"
80-
cargo install --locked typst-cli
81-
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
8265
- name: Checkout
8366
uses: actions/checkout@v4
8467
with:
@@ -89,11 +72,6 @@ jobs:
8972
uses: actions/configure-pages@v5
9073
- name: Install Node.js dependencies
9174
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
92-
- name: Render Typst code blocks
93-
run: |
94-
if [ -f scripts/render-typst.sh ]; then
95-
bash scripts/render-typst.sh
96-
fi
9775
- name: Build with Hugo
9876
env:
9977
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
66
and is generated by [Changie](https://github.com/miniscruff/changie).
77

88

9+
## v3.0.2 - 2025-10-01
10+
### Changed
11+
* README updated to reflect changes to GitHub actions
12+
### Removed
13+
* rust and `typst` install on GitHub actions
14+
915
## v3.0.1 - 2025-10-01
1016
### Changed
1117
* Fixed .gitignore to allowed rendered PDFs for posts

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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
5559
bash scripts/render-typst.sh
5660
```
5761

5862
This 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:
97101
3. 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

Comments
 (0)