README.md

Typst dev builds

Unofficial builds of Typst artifacts for development purposes.

• Artifacts:

  • docs Documentation (see below for explanation)
  • typst Typst
  • package-check Typst package check
  • packages-bundler The bundler for packages
  • hayagriva Hayagriva

  A machine-readable sorted catalog of published artifacts is available at catalog.json.

• Platform: Only x86_64 Linux (musl) and Windows binaries are offered for CLI programs.

  You can open an issue if you really need binaries for other platforms.

• Schedule: Workflows are triggered manually when requested.

• Retention

  Artifacts in Releases are practically permanent, and are suitable for CI.

  Artifacts in Actions are retained for 90 days before they are automatically deleted by GitHub.

Additional explanation for docs

The infrastructure for generating the documentation has been migrated from Markdown to Typst in #8138 in May 2026. Therefore, this project will publish different artifacts for future builds.

Future builds

• docit-* contain the binaries for the cargo docit CLI (aka. typst-docs).

  This CLI supports a stdx module with various utilities for the docs. For example, stdx.describe(calc.pow) provides details about calc.pow, including its name, docs, location of its definition in the Rust sources, and details about its parameters and return value. This module also offers stdx.live-item-data(), stdx.str-from-path(), stdx.latex-name(), stdx.raw-langs, and other functions and constants.

  When using this CLI, --workspace . is required for most use cases. Refer to typst-docs compile --help for the details.

• docs-website.zip and docs.pdf are the HTML and PDF versions of the documentation, respectively.

  These are generated by cargo docit compile with default options. Specifically, the "development version" warning is added, the base URL for the HTML files is set to /, and extra chapters (e.g., Roadmap) are not included.

At present, these artifacts are published only to Actions, but not Releases. They will be published to Releases once the future of typst-docs-web is decided.

docs-main.2026-05-05.0d72726, docs-v0.14.2, and earlier builds

• docs.json is the HTML-in-JSON representation of the documentation.
• docs-assets.zip contains preview images for the examples.

Both docs.json and docs-assets.zip are generated by the official typst-docs crate.

You can build a docs website from these files yourself by leveraging typst-docs-web and other unofficial tools. The base URL for the files is set to /DOCS-BASE/. Please replace the string with your actual base URL. For example, sd '/DOCS-BASE/' '/' docs.json.

Note that <contributors/> in changelog pages are collected during the closed-source build steps. docs.json here omits the list of contributors, because the resolver does not support it.

Debugging recipes

The following commands are for debugging build scripts, and are not intended for the general public.

Note that gh run download cannot download non-zipped artifacts as of 2026-10. Some commands below may not work as expected.

gh workflow run

docs

Future builds:

gh run download --name docit-x86_64-unknown-linux-musl
tar -xf docit-x86_64-unknown-linux-musl.tar.xz
./docit-x86_64-unknown-linux-musl/typst-docs --version

gh run download --name docit-x86_64-pc-windows-msvc
unzip docit-x86_64-pc-windows-msvc.zip
./docit-x86_64-pc-windows-msvc/typst-docs.exe --version

gh run download --name docs.pdf

gh run download --name docs-website.zip
unzip docs-website.zip
ls site/

docs-main.2026-05-05.0d72726, docs-v0.14.2, and earlier builds:

gh run download --name docs.json

gh run download --name docs-assets
unzip docs-assets.zip
ls assets/

typst

gh run download --name typst-x86_64-unknown-linux-musl
tar -xf typst-x86_64-unknown-linux-musl.tar.xz
./typst-x86_64-unknown-linux-musl/typst --version

gh run download --name typst-x86_64-pc-windows-msvc
unzip typst-x86_64-pc-windows-msvc.zip
./typst-x86_64-pc-windows-msvc/typst.exe --version

package-check

gh run download --name typst-package-check-x86_64-unknown-linux-musl
tar -xf typst-package-check-x86_64-unknown-linux-musl.tar.xz
./typst-package-check-x86_64-unknown-linux-musl/typst-package-check check --help

gh run download --name typst-package-check-x86_64-pc-windows-msvc
unzip typst-package-check-x86_64-pc-windows-msvc.zip
./typst-package-check-x86_64-pc-windows-msvc/typst-package-check.exe check --help

packages-bundler

gh run download --name packages-bundler-x86_64-unknown-linux-musl
tar -xf packages-bundler-x86_64-unknown-linux-musl.tar.xz
mkdir packages
./packages-bundler-x86_64-unknown-linux-musl/bundler --out-dir dist

gh run download --name packages-bundler-x86_64-pc-windows-msvc
unzip packages-bundler-x86_64-pc-windows-msvc.zip
mkdir packages
./packages-bundler-x86_64-pc-windows-msvc/bundler.exe --out-dir dist

bundler will read entries in the packages directory.

hayagriva

gh run download --name hayagriva-x86_64-unknown-linux-musl
tar -xf hayagriva-x86_64-unknown-linux-musl.tar.xz
./hayagriva-x86_64-unknown-linux-musl/hayagriva --version

gh run download --name hayagriva-x86_64-pc-windows-msvc
unzip hayagriva-x86_64-pc-windows-msvc.zip
./hayagriva-x86_64-pc-windows-msvc/hayagriva.exe --version