waylan/Python-Markdown
Python Markdown
Python-Markdown is a library that converts Markdown text into HTML or XHTML documents. It functions as a Unicode text processor, supporting all Unicode-based languages and bi-directional text to ensure global compatibility.
The project is an extensible markdown processor that allows developers to add custom syntax and formatting rules through a plugin architecture. This system enables the registration of new parsing rules, the modification of parser behavior, and the implementation of custom document syntax such as tables and footnotes without altering the core source code.
The tool provides a variety of rendering capabilities, including support for complex syntax, advanced formatting elements, and standardized list rendering. It supports both programmatic content processing within software applications and file-based conversion via a command line interface.
The library's conversion process includes capabilities for source text pre-processing, document tree transformation, and output post-processing.
Features
- Markdown to HTML Converters - Transforms Markdown plaintext markup into structured HTML or XHTML documents supporting any Unicode-based language.
- Markdown Processors - Functions as a software tool that parses and transforms lightweight markup syntax into standard web formats.
- Markdown Parsers - Implements a parsing engine that interprets standard markdown syntax for conversion into structured layouts.
- Extended Syntax Renderers - Supports extended markdown features such as tables and footnotes to meet specialized document requirements.
- Programmatic Content Conversion APIs - Provides developer interfaces for programmatically transforming markdown text strings or files into structured publishing formats.
- Unicode Text Processing - Supports all Unicode-based languages and bi-directional text to ensure global compatibility of converted documents.
- Parser Rule Extensions - Provides a plugin mechanism for adding custom parsing rules to the core processor without altering source code.
- Plugin-Based Architectures - Implements a plugin-based architecture that allows developers to add custom parsing rules and processors without modifying core source code.
- Syntax Extensions - Enables the definition of new structural elements such as footnotes and tables through an extensible syntax system.
- Regex Pattern Matching - Uses regular expression patterns to identify and replace markdown syntax with structured element nodes.
- Unicode Support - Supports all Unicode-based languages and bi-directional text to ensure global compatibility during document conversion.
- Markdown Conversions - Provides a command line interface for transforming Markdown files into HTML without requiring custom scripting.
- Styled Text to HTML Converters - Applies specialized inline styles and custom element nodes to raw text during the HTML conversion process.
- Custom Parsing Logic - Allows registration of custom processors and patterns with specific priorities to control the conversion process.
- Markup Syntax Extensions - Supports complex structures including definition lists and attribute lists during the conversion to HTML.
- Block Level Parsing Rules - Processes multi-line text segments into a hierarchy of block-level elements such as lists and tables.
- Priority-Based Rule Processing - Executes a series of parsing and post-processing functions ordered by numerical priority to transform document content.
- Technical Element Rendering - Provides rendering for complex technical structures including fenced code blocks and tables of contents.
- Document Tree Mutations - Allows programmatic modification of the internal element tree before final serialization into HTML.
- Custom Inline Element Definitions - Maps specific text patterns to custom element tree nodes to implement specialized inline formatting styles.
- Two-Pass Document Trees - Converts text into a structured element tree before serializing it into a final HTML string.
- HTML Preservation Stashes - Stashes unmodified HTML strings to prevent them from being processed by the markdown parser.
- Markdown Tools - Python implementation of the Markdown specification.
