Expand description
§Quillmark
Quillmark is a flexible, format-first Markdown rendering system that converts Markdown with YAML frontmatter into various output artifacts (PDF, SVG, TXT, etc.).
§Quick Start
use quillmark::{Document, OutputFormat, Quillmark, RenderOptions};
let engine = Quillmark::new();
let quill = engine.quill_from_path("path/to/quill").unwrap();
let parsed = Document::from_markdown("---\nQUILL: my_quill\ntitle: Hello\n---\n# Hello World").unwrap();
let result = quill.render(&parsed, &RenderOptions {
output_format: Some(OutputFormat::Pdf),
..Default::default()
}).unwrap();Re-exports§
pub use form::Form;pub use form::FormCard;pub use form::FormFieldSource;pub use form::FormFieldValue;pub use orchestration::Quill;pub use orchestration::Quillmark;
Modules§
- form
- Schema-aware form views for form editors.
- orchestration
- Orchestration
Structs§
- Artifact
- An artifact produced by rendering.
- Card
- A single metadata fence parsed from a Quillmark Markdown document.
- Diagnostic
- Structured diagnostic information.
- Document
- A fully-parsed, typed in-memory Quillmark document.
- Location
- Location information for diagnostics
- Parse
Output - Parse result carrying both the parsed document and any non-fatal warnings (e.g. near-miss sentinel lints emitted per spec §4.2).
- Render
Options - Internal rendering options.
- Render
Result - Result type containing artifacts and warnings
- Render
Session - Opaque, backend-backed iterative render session.
Enums§
- Output
Format - Output formats supported by backends.
- Parse
Error - Error type for parsing operations
- Render
Error - Main error type for rendering operations.
- Severity
- Error severity levels
Traits§
- Backend
- Backend trait for rendering different output formats.