Oak Markdown Parser

High-performance incremental Markdown parser for the oak ecosystem with flexible configuration, optimized for document processing and rendering.

🎯 Overview

Oak of markdown is a robust parser for Markdown, designed to handle complete Markdown syntax including modern features. Built on the solid foundation of oak-core, it provides both high-level convenience and detailed AST generation for document processing and rendering.

✨ Features

• Complete Markdown Syntax: Supports all Markdown features including modern specifications
• Full AST Generation: Generates comprehensive Abstract Syntax Trees
• Lexer Support: Built-in tokenization with proper span information
• Error Recovery: Graceful handling of syntax errors with detailed diagnostics

🚀 Quick Start

Basic example:

use oak_markdown::MarkdownParser;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let parser = MarkdownParser::new();
    let markdown_content = r#"
# Hello, Markdown!

This is a **paragraph** with *emphasis*.

## Features

- Lists
- Code blocks
- And more!
    "#;
    
    let document = parser.parse_document(markdown_content)?;
    println!("Parsed Markdown document successfully.");
    Ok(())
}

📋 Parsing Examples

Document Parsing

use oak_markdown::{MarkdownParser, ast::Document};

let parser = MarkdownParser::new();
let markdown_content = r#"
# My Document

This is a simple document.
"#;

let document = parser.parse_document(markdown_content)?;
println!("Document title: {}", document.title);

Heading Parsing

use oak_markdown::{MarkdownParser, ast::Heading};

let parser = MarkdownParser::new();
let markdown_content = r#"
## My Heading

Some content here.
"#;

let document = parser.parse_document(markdown_content)?;
for heading in &document.headings {
    println!("Heading level {}: {}", heading.level, heading.text);
}

🔧 Advanced Features

Token-Level Parsing

use oak_markdown::{MarkdownParser, lexer::Token};

let parser = MarkdownParser::new();
let tokens = parser.tokenize("# Heading\n\nParagraph text")?;
for token in tokens {
    println!("{:?}", token.kind);
}

Error Handling

use oak_markdown::MarkdownParser;

let parser = MarkdownParser::new();
let invalid_markdown = r#"
# Heading

This is a paragraph
## Another heading
# Unclosed heading
"#;

match parser.parse_document(invalid_markdown) {
    Ok(document) => println!("Parsed Markdown document successfully."),
    Err(e) => {
        println!("Parse error at line {} column {}: {}", 
            e.line(), e.column(), e.message());
        if let Some(context) = e.context() {
            println!("Error context: {}", context);
        }
    }
}

🏗️ AST Structure

The parser generates a comprehensive AST with the following main structures:

• Document: Root container for Markdown documents
• Heading: Heading elements with levels
• Paragraph: Text paragraphs
• List: Ordered and unordered lists
• CodeBlock: Fenced code blocks
• Inline: Emphasis, strong, links, and inline code

📊 Performance

• Streaming: Parse large Markdown files without loading entirely into memory
• Incremental: Re-parse only changed sections
• Memory Efficient: Smart AST node allocation
• Fast Recovery: Quick error recovery for better IDE integration

🔗 Integration

Oak of markdown integrates seamlessly with:

• Static Site Generators: Convert Markdown to HTML for websites
• Documentation Tools: Process and render Markdown documentation
• Content Management: Handle user-generated Markdown content
• IDE Support: Language server protocol compatibility
• Blog Platforms: Parse and render blog posts in Markdown

📚 Examples

Check out the examples directory for comprehensive examples:

• Complete Markdown document parsing
• Heading and list analysis
• Code transformation
• Integration with development workflows

🤝 Contributing

Contributions are welcome!

Please feel free to submit pull requests at the project repository or open issues.