OxydeMark
Extensible Markdown pipelines powered by Rust.
Overview
OxydeMark is a Markdown processing engine built around an AST pipeline architecture. It combines a high-performance Rust core for parsing and rendering with Python bindings (via PyO3) for a flexible plugin system.
Markdown Input
-> Preprocessing Plugins (Python, text-level)
-> Rust Parser / rushdown (AST generation)
-> AST exposed to Python (AstNode tree)
-> AST Transformation Plugins (Python, AST-level)
-> Rust Renderer (HTML generation)
-> Postprocessing Plugins (Python, HTML-level)
-> Final Output
Installation
Note: OxydeMark is in early development (pre-alpha). Installation from source is currently the only option.
# Clone the repository
# Install tools and build
Quick Start
=
=
=
Plugins
A plugin is any object implementing one or more of the preprocess,
transform and postprocess hooks. No base class, no registration:
return
=
oxydemark.contrib ships four worked examples (admonitions, shortcodes,
mentions, lazy images). See the plugin guide for the full
authoring documentation, including the AST value-semantics rules.
Development
See CONTRIBUTING.md for the full development guide.
# Set up tools and hooks
# Common tasks
Project Structure
oxydemark/
├── src/ # Rust core
│ ├── lib.rs # PyO3 module, parser/renderer wiring
│ ├── ast.rs # AstNode definition, arena-to-tree conversion
│ ├── extensions.rs # Comark parser/renderer extensions
│ └── html_render.rs # AST-to-HTML renderer
├── python/oxydemark/ # Python package
│ ├── __init__.py # Re-exports from native module
│ ├── api.py # OxydeEngine, plugin protocol
│ └── contrib/ # Example plugins (provisional surface)
├── docs/ # Documentation site sources
│ ├── plugins.md # Plugin authoring guide
│ ├── api/ # API reference pages
│ └── specs/ # OMEPs (design decisions)
├── .github/workflows/ # CI pipeline
├── Cargo.toml # Rust crate configuration
├── pyproject.toml # Python build config (maturin)
├── mise.toml # Task runner and tool versions
├── zensical.toml # Documentation site configuration
├── cliff.toml # Changelog generation
├── prek.toml # Pre-commit hooks
├── CONTRIBUTING.md # Contribution guidelines
└── LICENSE # MIT License
Design Decisions
Architectural and tooling decisions are documented as OMEPs (OxydeMark
Enhancement Proposals) in docs/specs/. See the
OMEP index for the full list.