lunet-io/markdig

Features

• CommonMark Compliant Parsers - A text processor that adheres to the CommonMark specification to ensure consistent parsing across different platforms.
• CommonMark Conversions - Provides a high-performance, specification-compliant conversion of standard CommonMark syntax into HTML.
• Markdown to HTML Converters - Transforms Markdown plaintext markup into structured HTML for web display using a high-performance processor.
• AST to HTML Renderers - Walks the document tree and dispatches nodes to specific renderers to generate HTML.
• Markdown Parsing Pipelines - Implements configurable pipelines that convert markdown text into structured formats using pluggable extensions.
• Markdown AST Parsing - Converts raw Markdown strings into a hierarchical abstract syntax tree that captures semantic structure.
• Markdown Processors - Provides a high-performance library for transforming Markdown text into HTML or other structured formats.
• Markdown to HTML Renderers - Utilizes a high-performance renderer to convert compliant Markdown text into HTML.
• Parser Configurations - Uses a configurable pipeline of block and inline parsers to determine how syntax patterns are recognized.
• Delimiter Parsing Rules - Creates parsing rules for paired delimiters and shortcodes to transform text patterns into structured nodes.
• Abstract Syntax Tree Parsing - Transforms source text into a structural abstract syntax tree before walking the tree for final output generation.
• Custom Parser Implementations - Implements flexible parsing logic to recognize non-standard syntax and map it to custom tree structures.
• Abstract Syntax Tree Generation - Generates detailed abstract syntax trees for structural analysis of Markdown source text.
• Block Level Parsing Rules - Implements parsing logic for identifying structural block elements like paragraphs and headings in a document.
• Custom Block Parsing Overrides - Implements custom block-level syntax to handle fenced containers and paragraph interruption rules.
• Inline Element Parsers - Implements specialized parsing to identify inline elements like emphasis and links within text blocks.
• Markdown AST Manipulation - Provides programmatic structural modification of a markdown abstract syntax tree while preserving hierarchy.
• Syntax Extensions - Adds custom elements by hooking into the parsing pipeline to recognize new structural patterns.
• Markdown Parser Extensions - Adds custom syntax by registering new parsers and renderers to transform text into specific AST nodes.
• Clickable Link Detections - Automatically converts email addresses, phone numbers, and URLs into clickable links.
• Custom Format Renderers - Transforms the parsed document tree into non-web formats such as LaTeX, XAML, or JSON.
• Extended Syntax Renderers - Provides support for non-standard Markdown extensions such as tables, task lists, and math blocks.
• Document Metadata Extraction - Extracts standard descriptive properties like author and title from YAML front matter in documents.
• Footnotes - Implements numbered references within a document that link to explanatory notes at the bottom.
• Mathematical Notation Renderers - Provides a specialized renderer to convert LaTeX mathematical notation within Markdown content into formatted HTML.
• Non-HTML Renderers - Employs a custom engine to transform parsed documents into non-HTML outputs like LaTeX.
• Markdown to Plain Text Converters - Strips all Markdown formatting markers and HTML tags to produce clean plain text.
• Front-Matter Data Models - Extracts structured metadata from YAML front matter blocks at the start of documents.
• Content Grouping Containers - Transforms fenced blocks or inline markers into HTML div containers to group related content.
• Static Site Generation - Extracts YAML front matter and converts structured documentation files into static HTML pages.
• Typographic Enhancements - Markdig replaces standard ASCII punctuation with typographically correct entities to improve appearance.
• Markdown Roundtrips - Preserves non-semantic whitespace and trivia to enable lossless roundtrip editing.
• Node Metadata Attachments - Stores arbitrary key-value data on individual tree nodes to carry additional contextual information.
• AST Mutations - Provides helper utilities to modify the document tree while maintaining correct parent-child relationships.
• Native AOT Compilation - Maintains compatibility with ahead-of-time compilation and trimming to minimize binary size.
• AOT-Compatible Libraries - A .NET implementation designed to work with ahead-of-time compilation and trimming to minimize binary size.
• AST-to-Source Mappings - Tracks exact character spans and whitespace of every AST node to enable lossless roundtripping to original text.
• Inline Node Rewiring - Processes the inline linked-list to rewire nested delimiters into final ordered structural elements.
• Format-Preserving Printing - Preserves original whitespace and formatting tokens when printing the abstract syntax tree back to source text.
• Stream-Based Rendering - Writes processed content directly to a text stream to minimize memory allocations for large documents.
• Parsing Depth Limits - Implements constraints on the maximum nesting level of parsed document elements to prevent stack overflow.
• AST Modification - Modifies document structure by removing or replacing nodes to transform content after the initial parsing phase.
• AST Traversal Engines - Implements depth-first walking of the document tree to locate or process specific nodes.
• AST Visitor Patterns - Walks the document tree and dispatches each node type to a specialized renderer using the visitor pattern.
• Heading Identifiers - Automates the generation of unique identifiers for document headings to enable deep linking.
• Inline Element Reconciliation - Processes linear inline sequences to resolve paired delimiters and nested elements into a final structural hierarchy.
• AST Node Metadata - Allows attaching typed key-value metadata directly to abstract syntax tree nodes to share state across processing phases.
• Output Streaming - Markdig writes processed content directly to a text stream to avoid loading large output strings into memory.
• Renderer Performance Optimizations - Markdig reduces memory allocations by caching processing pipelines and pooling renderer instances.
• Bootstrap CSS Integrations - Integrates Bootstrap CSS classes into generated HTML elements like tables, blockquotes, and figures.
• Captioned Figures - Renders images as figure elements with descriptive captions using specific marker syntax.
• Markdown Table Rendering - Converts pipe and grid style text into HTML tables with support for multi-line cells.
• Callout Block Rendering - Converts callouts into styled HTML elements to highlight important content within documentation.
• Manual Attribute Assignments - Assigns custom IDs, classes, and generic HTML attributes to headings and other elements.
• Text Rendering - Implements specialized typographic styles like strikethrough and superscript using character delimiters.
• Automatic Hyperlink Detection - Identifies plain text URLs and email addresses and automatically converts them into clickable hyperlinks.
• Custom Rendering Logic - Provides the ability to override the default HTML generation process via custom rendering logic.
• General Utilities - Fast and extensible Markdown processor.
• Markdown Processors - Fast, extensible, and CommonMark-compliant Markdown processor.

Star history