Crate quillmark 

Quillmark

Quillmark is a flexible, format-first Markdown rendering system that converts Markdown with card-yaml metadata blocks into various output artifacts (PDF, SVG, TXT, etc.).

Quick Start

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

let quill = quill_from_path("path/to/quill").unwrap();
let engine = Quillmark::new();

let parsed = Document::from_markdown("~~~\n$quill: my_quill\n$kind: main\ntitle: Hello\n~~~\n\n# Hello World").unwrap();
let result = engine.render(&quill, &parsed, &RenderOptions {
    output_format: Some(OutputFormat::Pdf),
    ..Default::default()
}).unwrap();

Re-exports

pub use orchestration::Quillmark;

Modules

orchestration

Orchestration

Structs

Artifact

An artifact produced by rendering.

Card

A single card-yaml block (root or composable). body is "" when no content follows the closing fence; check card.body().is_empty().

Diagnostic

Structured diagnostic information.

Document

A fully-parsed Quillmark document. Serde routes through StoredDocument; for the plate wire shape see Document::to_plate_json.

Location

ParseOutput

Parse result with the document and any non-fatal warnings.

Quill

Portable, validated quill data: the file bundle, parsed config, and metadata of an authored quill, tagged with its declared backend id.

RenderOptions

Internal rendering options.

RenderResult

RenderSession

Opaque, backend-backed iterative render session.

Enums

OutputFormat

Output formats supported by backends.

ParseError

RenderError

Main error type for rendering operations.

Severity

Traits

Backend

Backend trait for rendering different output formats.

Functions

quill_from_path

Load a quill from a filesystem directory. Honours a root .quillignore, else a default ignore set. (The fs walk lives here; core stays fs-agnostic.)