syntax-tree/mdast
Mdast
The project provides a standardized abstract syntax tree specification and utility library for parsing, transforming, and serializing markdown documents. It serves as a comprehensive document processing architecture that translates between raw text markup and structured node representations in both directions.
The capability surface covers syntax parsing for extended markdown features, custom syntax extensions, metadata blocks, and embedded expressions, alongside document serialization that converts syntax trees back into standard and extended markup formats. It includes node modeling and validation primitives that define document structures, component tags, and recursive tree integrity, supported by content manipulation tools for extracting sections, resolving definitions, and transforming trees.
Features
- Markdown Parsers - Parses markdown text into structured abstract syntax trees and serializes trees back into standard markup.
- Document Parsers - Converts raw markdown text into structured abstract syntax tree nodes programmatically so documents can be analyzed and manipulated.
- Abstract Syntax Tree Generators - Navigates, filters, cleans, and transforms document syntax trees to restructure content or extract specific sections.
- Abstract Syntax Tree Specifications - Represents document structure using standardized node types and interfaces to enable consistent programmatic parsing.
- Markdown Abstract Syntax Trees - Defines a structured node format representing markdown documents as abstract syntax trees to parse and manipulate content programmatically.
- HTML Tree Converters - Converts markdown abstract syntax trees into corresponding HTML abstract syntax trees to bridge text markup and web-ready document structures.
- Tree-to-Text Serializers - Converts syntax trees containing embedded expressions and component syntax back into serialized markdown documents.
- Extended Syntax Renderers - Reconstructs markdown documents from abstract syntax trees, outputting extended features like tables and footnotes.
- Plain Text Extraction - Retrieves plain text from markdown nodes, lists, or arrays by reading text fields or serializing children.
- Document Tree Transformation Pipelines - Applies sequential handler functions and plugins to transform document trees into different formats or target syntax trees.
- Visitor Pattern Traversers - Traverses hierarchical document trees recursively to inspect, validate, and transform specific node types.
- Text - Scans document text nodes in preorder to locate patterns and replace them with generated nodes.
- Markup Representations - Provides bidirectional conversion between raw text markup and structured abstract syntax tree representations.
- Markdown AST Manipulation - Parses markdown text into structured nodes and serializes trees back into markup for programmatic document manipulation.
- Markdown Node Querying and Modification - Offers a complete toolset for traversing, querying, modifying, and validating nodes within markdown abstract syntax trees.
- Markdown Parser Extensions - Builds custom parsers and plugins to support non-standard markdown features like frontmatter, math, and tables.
- Document Frontmatter Parsers - Converts embedded metadata blocks at the start of documents into structured nodes during parsing by using configurable syntax extensions.
- Section Content Extractors - Locates a specific heading within a document structure and isolates its section content up to the next heading.
- Markdown HTML Conversions - Translates markdown syntax trees into HTML elements or natural language structures for browser rendering and downstream processing.
- Secure Markdown Rendering - Processes raw HTML within markdown content while sanitizing untrusted inputs or managing dangerous markup flags to prevent security vulnerabilities.
- Component Tag Node Representations - Models inline and block-level component tags, including fragments, names, and attributes, as structured nodes within document trees.
- Syntax Extension Serializers - Integrates additional syntax plugins to serialize specialized constructs like tables, math, and frontmatter into valid markdown.
- Automatic Table of Contents - Builds a nested list of document headings from a syntax tree and generates navigation anchor links.
- Markup Syntax Extensions - Supports pluggable parser and serializer extensions for custom syntax nodes and non-standard markdown features.
- Module Import and Export Processors - Transforms embeddable module import and export syntax between raw markdown text and abstract syntax tree nodes in both directions.
- Custom Markdown - Builds extensions that plug into parsers and serializers to support custom syntax nodes within documents.
- Markdown Document Tree Validators - Checks that a document tree conforms to structural rules and recursively verifies all nested children down the line.
- Component Syntax Processors - Transforms XML-like component syntax within documents into syntax tree nodes and serializes those trees back into markup.
- Embedded Expression Parsers - Parses embedded expressions, JSX elements, and module imports within markdown documents into structured syntax tree nodes.
- Markdown Directive Nodes - Structures markdown text containers and text elements with names, attributes, and content into standardized syntax tree nodes.
