pulldown-cmark/pulldown-cmark
Pulldown Cmark
pulldown-cmark is a pull-parsing library that transforms Markdown text into a stream of events based on the CommonMark specification. It functions as an event-based processor that represents document structure as an iterator of events rather than a concrete syntax tree, serving as both a parser and a renderer to convert Markdown into HTML strings.
The library is designed for memory efficiency by processing text as a stream to minimize resource usage. It supports programmatic document transformation, allowing users to map or filter the event stream before final rendering.
The project includes capabilities for tracking source offsets to link rendered output back to original byte ranges. It also supports extended Markdown syntax, providing the ability to parse and process non-standard elements such as tables and task lists.
Features
- CommonMark Compliant Parsers - Implements a pull-parsing library that strictly adheres to the CommonMark specification for consistent markdown processing.
- Markdown to HTML Converters - Converts parsed Markdown events into HTML strings for web browser display.
- Markdown Processors - Processes Markdown text as a stream of events to transform lightweight markup into structured document types.
- Markdown Parsing Pipelines - Provides a pull-parsing pipeline to convert Markdown text into a structured event stream.
- Event-Based Converters - Transforms Markdown text into a stream of iterator-based events for rendering or modification.
- Structural Event Streaming - Uses a pull-parsing approach to stream documents as a sequence of structural events, minimizing memory usage.
- Event-Based Stream Processing - Processes Markdown as an event stream to ensure low memory overhead and high speed.
- Markdown Extensions - Extends standard CommonMark with support for custom elements like tables and task lists.
- Document Transformation Pipelines - Provides a framework for programmatically filtering and transforming the event stream before final rendering.
- Pull Parsers - Provides a memory-efficient pull-parsing architecture that processes text as a stream to reduce resource usage.
- Iterable Transformation Utilities - Provides functional iterator combinators to map or filter the stream of parsed Markdown events.
- Source Tracking - Identifies the original byte ranges for each parsed event to enable accurate source mapping.
- Event-to-Source Mapping - Tracks the original byte offsets of parsed Markdown elements to link output back to source text.
- Event-to-State Transformations - Allows users to apply custom logic to the Markdown event stream via iterator combinators.
- Single-Pass Tokenizers - Employs a single-pass linear parsing strategy to identify Markdown structures efficiently.
- Offset Tracking - Maintains byte range offsets during parsing to map rendered output back to original source positions.
- Syntax Parsing Engines - Implements parsing logic for non-standard Markdown features like footnotes and flavored tables.
- Event-Driven Renderers - Implements an event-driven rendering process to convert structural Markdown events into HTML strings.
- Syntax Extensions - Supports extended Markdown syntax including tables and task lists.
