xoofx/markdig
Markdig
Markdig is a markdown parser library that converts text into structured HTML, plain text, or other formats using a configurable pipeline. It functions as a CommonMark compliant parser and an abstract syntax tree generator that transforms markdown into a hierarchical tree of block and inline nodes with precise source location mapping.
The project is distinguished by a decoupled renderer architecture that separates parsing logic from output generation, enabling the transformation of the syntax tree into non-HTML formats such as LaTeX or XAML. It also serves as a lossless markdown processor by tracking non-semantic whitespace and trivia, which allows documents to be re-rendered without losing original formatting.
The library covers a broad range of capabilities including the ability to extend markdown syntax through pluggable parser extensions and the manipulation of the abstract syntax tree for document analysis. It supports advanced elements such as tables, mathematics, and footnotes, and includes features for international text handling, typography enhancements, and YAML front matter extraction.
Rendered output can be written directly to a text stream to reduce memory overhead for large documents.
Features
- Markdown to HTML Converters - Transforms Markdown plaintext markup into structured HTML for web display.
- CommonMark Compliant Parsers - Adheres to the CommonMark standard to ensure consistent processing of headings, lists, and links.
- Markdown Abstract Syntax Trees - Generates an abstract syntax tree with precise source locations to power external analysis tools and highlighters.
- Tree-to-Text Serializers - Implements a mechanism to serialize the abstract syntax tree back into various text formats.
- Markdown Parsers - Supports extending standard markdown syntax through a pluggable pipeline of custom block and inline parsers.
- Custom Format Renderers - Transforms parsed markdown into alternative output formats such as LaTeX or XAML.
- Markdown Parsing Pipelines - Converts markdown text into structured HTML or other formats using a configurable pipeline of extensions.
- Markdown Renderers - Provides a flexible rendering system to transform parsed markdown into multiple target formats.
- Non-HTML Renderers - Enables transformation of markdown into alternative formats like LaTeX and XAML via a decoupled architecture.
- Markdown to Plain Text Converters - Strips all formatting and HTML tags from a document to produce a clean, text-only version of content.
- Trivia Tracking - Ensures lossless processing by tracking whitespace and trivia, allowing the source to be re-rendered exactly.
- Source Text Mapping - Maps every node in the parsed syntax tree to its precise character offsets in the source text.
- AST Node Location Mapping - Maps every node in the parsed syntax tree back to its exact character offsets and line positions.
- Abstract Syntax Tree Parsing - Provides the ability to parse markdown into a structured abstract syntax tree for further analysis and rendering.
- Parser Rule Extensions - Provides a pluggable system for adding custom block and inline parsing rules to the markdown processor.
- Markdown Block Formatting - Produces structured components such as blockquotes and thematic breaks based on markdown markers.
- Text Formatting Tools - Applies bold and italic styling to text using standard markdown emphasis markers.
- Markdown - Supports custom markers and structural elements through a pluggable processing pipeline.
- Unordered Lists - Generates structured ordered and unordered lists, including support for nested items.
- Markdown Parser Extensions - Supports the registration of custom block and inline parsers to expand supported markdown syntax.
- Markdown Processors - Acts as a lossless processor by tracking non-semantic whitespace and trivia for exact re-rendering.
- Technical Content Renderers - Provides rendering for advanced technical elements including mathematics, tables, and footnotes.
- Document Metadata Extraction - Extracts YAML front matter and manages pragma lines to enrich document metadata.
- Code Display & Snippets - Supports the rendering of inline and block code snippets with language identifiers.
- Plain Text Converters - Provides the ability to strip all formatting and tags to output plain-text content.
- Markdown Roundtrips - Parses trivia characters like whitespace to allow documents to be modified and rendered without losing original formatting.
- Parsing Rule Configurations - Allows users to toggle specific syntax extensions and parsing rules through a configuration pipeline.
- Format-Preserving Printing - Tracks non-semantic elements and whitespace during parsing to ensure the document can be re-rendered exactly.
- Stream-Based Rendering - Writes rendered content directly to a text stream to reduce memory overhead for large documents.
- International Markdown Formatting - Supports right-to-left text layouts and applies specialized emphasis delimiter rules for CJK languages.
- Character-Level Parser Entry Points - Allows registering pluggable entry points at the character level to add parsing logic for new syntax elements.
- Logic-Rendering Decouplers - Separates the markdown parsing logic from the rendering stage to allow for multiple output formats.
- Two-Stage Parsing - Utilizes a two-stage parsing process that separates block-level structure scanning from inline value extraction.
- Document Tree Traversers - Implements depth-first search traversal of the document tree for analysis and modification.
- Syntax Tree Construction - Provides the ability to traverse and programmatically modify the syntax tree before rendering.
- Markdown AST Manipulation - Performs structural changes to the document tree while preserving parent-child relationships.
- Streaming Rendering - Writes converted markdown content directly to a text stream to minimize memory usage for large documents.
