comrak

Python bindings for the Comrak Rust library, a fast CommonMark/GFM parser.

Currently tracking comrak 0.54.

Installation

pip install comrak

Requirements

• Python 3.9+

Usage

>>> import comrak
>>> comrak.render_markdown("# Hello")
'<h1>Hello</h1>\n'

Options

Every option in comrak's Extension, Parse and Render structs is exposed, with the same name and the same default:

>>> opts = comrak.ExtensionOptions()
>>> comrak.render_markdown("foo :smile:", extension_options=opts)
'<p>foo :smile:</p>\n'
>>> opts.shortcodes = True
>>> comrak.render_markdown("foo :smile:", extension_options=opts)
'<p>foo 😄</p>\n'

The three option objects are independent and can be combined:

>>> ext = comrak.ExtensionOptions()
>>> ext.alerts = True
>>> render = comrak.RenderOptions()
>>> render.alert_style = comrak.AlertStyle.Semantic
>>> comrak.render_markdown("> [!note]\n> Note this!",
...                        extension_options=ext, render_options=render)
'<aside class="admonition note">\n...'

For what each option does, see comrak's own documentation. The field names match one-for-one:

• options::Extension
• options::Parse
• options::Render

Two options take enums rather than raw values: RenderOptions.alert_style (comrak.AlertStyle) and RenderOptions.list_style (comrak.ListStyle). Both compare equal to their integer discriminants.

The one naming difference from the Rust API is:

ExtensionOptions.header_ids is a deprecated alias for header_id_prefix and raises a FutureWarning; it will be removed in a future release.

Not exposed

• parse.broken_link_callback — see tracking issue
• extension.phoenix_heex — gated behind a comrak crate feature that isn't built here
• Plugins (syntax highlighting, heading adapters)

Only HTML output is available, via render_markdown. The options that solely affect comrak's CommonMark formatter (width, list_style, prefer_fenced, ol_width, experimental_minimize_commonmark) are settable for API parity but currently have no effect.

Benchmarks

Tested with small (8 lines) and medium (1200 lines) markdown strings

• vs. markdown: 15x faster (S/M)
• vs. markdown2: 20x (S) - 60x (M) faster

Contributing

Maintained by lmmx. Contributions welcome!

1. Issues & Discussions: Please open a GitHub issue or discussion for bugs, feature requests, or questions.
2. Pull Requests: PRs are welcome!
   • Set up with uv: uv sync
   • Build and test: uv run maturin develop && uv run pytest
   • If reporting a bug, please include the version and the error message/traceback if available.

New comrak options are caught at compile time by an exhaustiveness check in src/options.rs, and untested options are caught by TestOptionCoverage in tests/comrak_test.py. This was introduced to help keep track of new comrak features and their test coverage in this library.

License

Licensed under the 2-Clause BSD License. See LICENSE for all the details.