Typst.Native 0.2.0

Typst.Native

.NET bindings for Typst, the modern markup-based typesetting system.

Typst.Native lets you compile Typst documents to PDF, SVG, and PNG directly from .NET — no CLI installation or external processes required.

Features

• Native performance: calls Typst's Rust core via P/Invoke (no WASM overhead)
• Cross-platform: ships pre-built native libraries for Windows, Linux, and macOS (x64 + ARM64)
• Zero external dependencies: everything is bundled in the NuGet package
• Idiomatic C# API: TypstCompiler, diagnostics, streaming output

Quick Start

dotnet add package Typst.Native

using Typst.Native;

using var compiler = new TypstCompiler();

var result = compiler.Compile("Hello, *Typst* from .NET!");

if (result.IsSuccess)
{
    byte[] pdf = result.ToPdf();
    File.WriteAllBytes("output.pdf", pdf);
}
else
{
    foreach (var diag in result.Diagnostics)
        Console.Error.WriteLine(diag);
}

Supported Platforms

Building from Source

Prerequisites

• .NET 8.0 SDK or later
• Rust toolchain (stable)

Build the native library

cd native/typst-ffi
cargo build --release

The shared library will be output to native/typst-ffi/target/release/.

Build the .NET solution

dotnet build
dotnet test

Note: To run tests locally, you need to first build the native library and place it in the appropriate runtimes/{rid}/native/ directory under src/Typst.Native.Runtime/.

Architecture

Typst.Native/
├── native/typst-ffi/          # Rust FFI crate — thin C API over Typst
├── src/
│   ├── Typst.Native/           # Managed C# wrapper (main NuGet: Typst.Native)
│   ├── Typst.Native.Runtime/   # Native binaries package (Typst.Native.Runtime)
│   └── Typst.Native.Tests/     # Unit & integration tests
└── .github/workflows/         # CI/CD pipelines

Packages

Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-feature)
3. Commit your changes
4. Push to the branch and open a Pull Request

License

This project is licensed under the MIT License.

Typst itself is licensed under the Apache License 2.0. See the Typst repository for details.