Installation¶

Important

To compile your Typst files, we use the Typst CLI. Make sure you have it installed.

If you are on Windows and are unfamiliar with downloading CLIs, the winget method may be easiest.

After Typst is installed, use one of the compile-typst-site installation methods below.

From a precompiled binary (for beginners)¶

See the releases to install from a precompiled binary.

Check that Typst and compile-typst-site were installed properly by printing their versions. If there are no errors, you’re done with installation. It should look something like this:[1]

$ typst --version
typst 0.14.0 (dd1e6e94)

$ compile-typst-site --version
compile-typst-site v0.3.1

From cargo-binstall¶

If you know what this is, yes, we support this.

$ cargo binstall compile-typst-site

Compile from source¶

You probably know what you’re doing.

[!NOTE] The latest stable versions are the releases. They can be found above, or tagged on Github. The main branch, if ahead of a stable release, has alpha content. But it passed the test suite, and probably works fine. Other branches like wade-cheng/dev are wild territory. Beware.

# from github
$ cargo install --git https://github.com/wade-cheng/compile-typst-site.git

# from latest release on crates.io
$ cargo install compile-typst-site