Quillmark

Quills define document presentation and schema. Use a quill to generate a formatted document from markdown or code.

Maintained by borb-sh.

UNDER DEVELOPMENT: APIs may change.

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, OutputFormat, Quillmark, RenderOptions};

// A `Quill` is declarative data: no engine needed to load it.
let quill = quill_from_path("path/to/quill")?;
let engine = Quillmark::new();

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

# Hello World
"#;

// The bound door: parse and conform against the quill that will render it.
let doc = quill.parse(markdown)?.document;
let result = engine.render(
    &quill,
    &doc,
    &RenderOptions::default().with_output_format(OutputFormat::Pdf),
)?;

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

Examples

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

Contributing

See CONTRIBUTING.md.

License

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