Skip to main content

Crate quillmark_typst

Crate quillmark_typst 

Source
Expand description

§Typst Backend for Quillmark

This crate provides a complete Typst backend implementation that converts Markdown documents to PDF and SVG formats via the Typst typesetting system.

§Overview

The primary entry point is the TypstBackend struct, which implements the Backend trait from quillmark-core. Users typically interact with this backend through the high-level Quill API from the quillmark crate.

§Features

  • Converts CommonMark Markdown to Typst markup
  • Compiles Typst documents to PDF and SVG formats
  • Provides template filters for YAML data transformation
  • Manages fonts, assets, and packages dynamically
  • Embeds unsigned AcroForm signature widgets via the signature-field helper (see signature-field in the lib.typ helper package; only the PDF output carries the widget — SVG and PNG render an invisible placeholder)
  • Thread-safe for concurrent rendering

§Modules

  • convert - Markdown to Typst conversion utilities
  • compile - Typst to PDF/SVG compilation functions

Note: The error_mapping module provides internal utilities for converting Typst diagnostics to Quillmark diagnostics and is not part of the public API.

Modules§

compile
Typst Compilation
convert
Markdown to Typst Conversion
helper
Quillmark Helper Package Generator

Structs§

TypstBackend
Typst backend implementation for Quillmark.
TypstSession
Typst-specific render session.

Functions§

typst_session_of
Borrow the TypstSession underlying a RenderSession, if the session was opened by the Typst backend.