Guide: Preview typst.app/docs (of your PR) on netlify

Y.D.X · September 4, 2025, 4:57pm

I’ve updated the build script with latest commits in the typst-jp repo. It’s simpler thanks to works in Make the website static site generator distributable · Issue #233 · typst-jp/docs · GitHub.

However, I can’t edit my original post anymore. The script will live here:

github.com/YDX-2147483647/typst

netlify-build-docs.sh

netlify-base

#!/usr/bin/env bash
set -euxo pipefail

# 1. Install tools

curl -sS https://webi.sh/sd | sh && source ~/.config/envman/PATH.env
curl https://mise.run | sh

# 2. Clone typst-jp/docs

# Tested against https://github.com/typst-jp/docs/commit/529c33dec006b20729795ca64e3079e18ae4e1d9
git clone --depth 1 --no-checkout --filter=tree:0 https://github.com/typst-jp/docs ../jp
cd ../jp
git sparse-checkout init
git sparse-checkout set website/ tsconfig.json package.json bun.lockb .mise.toml
git switch main
cd -

# 3. Move files from typst-jp/docs

This file has been truncated. show original

Note that I’ve changed the base from /docs/ to /:

The URL of docs.json is not affected.

See also Best of Typst (TCDM) for alternative infrastructure of building the Typst documentation.