1. Introduction
  3. User Guide
  4. 1. Installation
  5. 2. Quick Start
  6. 3. Changelog
  8. Usage
  9. 4. Command Line Interface
  10. 5. Editor Integration
  12. Features
  13. 6. Formatting Features
    1. 6.1. Markup
    2. 6.2. Code
    3. 6.3. Math Equations
    4. 6.4. Tables
  15. 7. Escape Hatch
  16. 8. Limitations
  18. Advanced
  19. 9. How It Works
  20. 10. Developer Guide
    1. 10.1. Core
    2. 10.2. Documentation
    3. 10.3. Playground

typstyle

#

Installation & Setup

Typstyle can be installed and used in multiple ways. Choose the method that best fits your workflow.

#

CLI Installation

#

Download Binary

The easiest way to get started is to download the pre-built binary from the release page.

#

Package Managers

Packaging status

Typstyle is available in many package managers. Check the packaging status for your distribution.

Notably, typstyle is available in Archlinux CN repo.

#

Cargo Installation

#
Using cargo-binstall (Recommended)
cargo binstall typstyle
#
Building from Source
cargo install typstyle --locked

#

Editor Integration

Typstyle has been integrated into tinymist. You can use it in your editor by installing the tinymist plugin and set tinymist.formatterMode to typstyle.

#

VS Code (via Tinymist)

  1. Install the Tinymist extension
  2. Set tinymist.formatterMode to "typstyle" in your settings
  3. Enable format on save or use Ctrl+Shift+P → "Format Document"

#

Library Installation

Typstyle is also available as a library integrated in your project.

#

Cargo (Rust)

[dependencies]
typstyle-core = "=0.13.11"

Note: Typstyle follows Typst’s major and minor versioning, and even patch releases may introduce breaking changes. We recommend pinning the version in your dependency and upgrading only when you require new features.

#

NPM (JavaScript/TypeScript)

TODO

#

GitHub Actions

Use the 3rd party-maintained typstyle-action by grayespinoza:

- name: Run typstyle
  uses: grayespinoza/typstyle-action@main

#

Pre-commit Hook

Not properly done yet.