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

#

Developer Guide

This guide covers environment setup, building, testing, and documentation for typstyle.

#

Prerequisites

  • Rust stable toolchain with cargo
  • Node.js and yarn (for web assets)
  • cargo-nextest and cargo-insta (for testing)
  • shiroa (for documentation)

#

Initial Setup

Clone and build the project:

git clone https://github.com/typstyle-rs/typstyle.git
cd typstyle
cargo build              # Debug build
cargo build --release    # Release build

Install required tools:

# For testing
cargo binstall cargo-nextest cargo-insta
# For building wasm
cargo binstall wasm-pack
# For documentation
cargo binstall shiroa

#

Workspace Layout

  • crates/typstyle/ — formatter CLI
  • crates/typstyle-core/ — core formatting logic
  • crates/typstyle-consistency/ — consistency test framework
  • crates/typstyle-typlugin/ — typst plugin for embedded usage
  • crates/typstyle-wasm/ — wasm bindings
  • tests/ — integration tests and fixtures
  • docs/ — documentation source (based on shiroa and written in typst)
  • contrib/typstyle-embedded/ — typstyle as typst package
  • playground/ — web-based interactive playground