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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! struckdown is a text processing system based on markdown/commonmark with
//! structured extensions inspired by reStructuredText.  It parses commonmark
//! with structural extensions (roles and directives) into an event stream.
//!
//! This event stream can be processed before rendering.
//!
//! # Example
//!
//! ~~~
//! use struckdown::pipeline::Pipeline;
//! use struckdown::processors::{AutoAnchors, Syntect};
//! use struckdown::html::to_html;
//!
//! // create a default pipeline
//! let mut pipeline = Pipeline::default();
//!
//! // add a processor for anchors and syntax highlighting.
//! pipeline.add_processor(AutoAnchors::default());
//! pipeline.add_processor(Syntect::default());
//!
//! // parse and process into a final event stream.
//! let stream = pipeline.process(r#"
//! # Hello World
//! ```python
//! print("Hello World!");
//! ```"#);
//!
//! // render to html
//! let html = to_html(stream, &Default::default());
//! ~~~
pub mod event;
pub mod html;
pub mod parser;
pub mod pipeline;
pub mod processors;

// internal only for now
mod plain;

/// Gives access to [`serde_json`] value functionality.
///
/// The [`Value`](crate::value::Value) type is used to represent arbitrary data in a few instances.
/// A notable example is emitted [`front_matter`](crate::event::DocumentStartEvent::front_matter)
/// or other [`MetaData`](crate::event::MetaDataEvent).
pub mod value {
    pub use serde_json::value::*;

    /// A re-export of the [`serde_json::json`] macro.
    pub use serde_json::json as value;

    pub use serde_json::{from_value, to_value};
}