panache-parser 0.10.0

Lossless CST parser and syntax wrappers for Pandoc markdown, Quarto, and RMarkdown
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
35
36
37
38
39
40
41
42
43
44
45

//! `panache-parser` is a lossless Concrete Syntax Tree (CST) parser for Pandoc
//! Markdown, Quarto, and R Markdown documents.
//!
//! It preserves source structure and trivia (including markers and whitespace),
//! making it suitable for editor tooling and formatting pipelines that require
//! deterministic round-tripping.
//!
//! # Quick start
//!
//! ```rust
//! use panache_parser::parse;
//!
//! let tree = parse("# Heading\n\nParagraph text.", None);
//! println!("{:#?}", tree);
//! ```
//!
//! # Main entry points
//!
//! - [`parse`]: Parse input text into a [`SyntaxNode`].
//! - [`to_pandoc_ast`]: Project a [`SyntaxNode`] into pandoc-native AST text.
//! - [`ParserOptions`]: Parser configuration and extension toggles.
//! - [`syntax`]: Typed syntax wrappers and syntax kinds.
//! - [`parser`]: Lower-level parser modules and incremental helpers.
//!
mod options;
pub mod pandoc_ast;
pub mod parser;
pub mod range_utils;
pub mod syntax;

/// Re-export of the [`entities`] crate (HTML5 named-entity table). Downstream
/// crates should consume the table through this re-export so the parser remains
/// the single source of truth for HTML entity data.
pub use entities;

pub use options::Dialect;
pub use options::Extensions;
pub use options::Flavor;
pub use options::PandocCompat;
pub use options::ParserOptions;
pub use pandoc_ast::{to_pandoc_ast, to_pandoc_json};
pub use parser::inlines::refdef_map::{RefdefMap, collect_refdef_labels};
pub use parser::parse;
pub use parser::parse_with_refdefs;
pub use syntax::SyntaxNode;