Typst

Typst is a new markup-based typesetting system that is designed to be as powerful as LaTeX while being much easier to learn and use. Typst has: Built-in markup for the most common formatting tasks Flexible functions for everything else A tightly integrated scripting system Math typesetting, bibliography management, and more Fast compile times thanks to incremental compilation Friendly error messages in case something goes wrong This repository contains the Typst compiler and its CLI, which is everything you need to compile Typst documents locally. For the best writing experience, consider signing up to our [collaborative online editor][app] for free. Installation Typst's CLI is available from different sources: You can get sources and pre-built binaries for the latest release of Typst from the [releases page][releases]. Download the archive for your platform and place it in a directory that is in your PATH . To stay up to date with future releases, you can simply run typst update . You can install Typst through different package managers. Note that the versions in the package managers might lag behind the latest release. Linux: View [Typst on Repology][repology] View [Typst's Snap][snap] macOS: brew install typst Windows: winget install --id Typst.Typst If you have a [Rust][rust] toolchain installed, you can install the latest released Typst version with cargo install --locked typst-cli a development version with cargo install --git --locked typst-cli Nix users can use the typst package with nix-shell -p typst build and run the Typst flake with nix run github:typst/typst-flake -- --version . Docker users can run a prebuilt image with docker run ghcr.io/typst/typst:latest --help . You can also watch source files and automatically recompile on changes. This is faster than compiling from scratch each time because Typst has incremental compilation. If you prefer an integrated IDE-like experience with autocompletion and instant preview, you can also check out our [free web app][app]. Alternatively, there is a community-created language server called Tinymist which is integrated into various editor extensions. Community The main places where the community gathers are our [Forum][forum] and our [Discord server][discord]. The Forum is a great place to ask questions, help others, and share cool things you created with Typst. The Discord server is more suitable for quicker questions, discussions about contributing, or just to chat. We'd be happy to see you there! [Typst Universe][universe] is where the community shares templates and packages. If you want to share your own creations, you can submit them to our [package repository][packages]. Contributing We love to see contributions from the community. If you experience bugs, feel free to open an issue. If you would like to implement a new feature or bug fix, please follow the steps outlined in the [contribution guide][contributing]. To build Typst yourself, first ensure that you have the [latest stable Rust][rust] installed. Then, clone this repository and build the CLI with the following commands: Another good way to contribute is by [sharing packages][packages] with the community. We'd like to thank everyone who is supporting Typst's development, be it via [GitHub sponsors] or elsewhere. In particular, special thanks[^1] go to: Posit for financing a full-time compiler engineer NLnet for supporting work on Typst via multiple grants through the NGI Zero Core fund: Work on HTML export Work on PDF accessibility Science & Startups for having financed Typst development from January through June 2023 via the Berlin Startup Scholarship Zerodha for their generous one-time sponsorship [^1]: This list only includes contributions for our open-source work that exceed or are expected to exceed €10K.