quillmark 0.92.0

Quillmark engine API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! # 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
//!
//! ```no_run
//! 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-export core types for convenience. `Quill` is the single quill type
// (engine-free, validated data); construct it from an in-memory tree with
// `Quill::from_tree`, or from disk with the `quill_from_path` helper below.
pub use quillmark_core::{
    Artifact, Backend, Card, Diagnostic, Document, Location, OutputFormat, ParseError, ParseOutput,
    Quill, RenderError, RenderOptions, RenderResult, RenderSession, Severity,
};

// Declare modules
mod load;
pub mod orchestration;

pub use load::quill_from_path;
pub use orchestration::Quillmark;