Quillmark

A format-first Markdown rendering system that converts Markdown with card-yaml metadata blocks into PDF, SVG, PNG, and other output formats.

Maintained by quillmark-org.

UNDER DEVELOPMENT — APIs may change.

Features

• Format-driven: Quills define structure and styling; Markdown provides content.
• Schema-backed validation: typed coercion, defaults, and constraints via QuillConfig.
• Typst backend: produces PDF, SVG, and PNG.
• Structured diagnostics: path-aware errors and warnings.

Documentation

• User Guide - Tutorials, concepts, and bindings
• Rust API Reference - Rust crate docs
• Changelog - Release notes and version history (GitHub Releases)

Installation

cargo add quillmark

Quick Start (Rust)

use quillmark::{quill_from_path, Document, OutputFormat, Quillmark, RenderOptions};

// A `Quill` is engine-free, validated data.
let quill = quill_from_path("path/to/quill")?;
let engine = Quillmark::new();

let markdown = r#"~~~
$quill: my_quill
$kind: main
title: Example
~~~

# Hello World
"#;

let doc = Document::from_markdown(markdown)?;
let result = engine.render(
    &quill,
    &doc,
    &RenderOptions {
        output_format: Some(OutputFormat::Pdf),
        ..Default::default()
    },
)?;

let pdf_bytes = &result.artifacts[0].bytes;

Examples

cargo run --example usaf_memo
cargo run --example taro

Project Structure

• crates/core - Core parsing, schema, and backend traits
• crates/quillmark - Rust orchestration API
• crates/backends/typst - Typst backend
• crates/bindings/python - Python bindings
• crates/bindings/wasm - WebAssembly bindings
• crates/bindings/cli - Command-line interface
• crates/fixtures - Test fixtures and sample Quill templates
• crates/fuzz - Property-based fuzzing tests
• prose/canon - Design documentation

Contributing

See CONTRIBUTING.md.

License

Licensed under the Apache License, Version 2.0. See LICENSE.