Ultra Markdown âš¡¶
Ultra Markdown, an ultra fast (high performance) Markdown parser written in pure C with bindings for Python 3.8+.
Source : https://github.com/kumaraditya303/umarkdown
Docs : https://umarkdown.netlify.app/
Ultra Markdown, an ultra fast (high performance) Markdown parser compliant with the markdown spec written in pure C with bindings for Python 3.8+. Unlike others, Ultra Markdown is written using Python's C API and uses CMark, an ultra fast Markdown parser written in C.
Features 🚀¶
- Fast - Very high performance, One of the fastest Markdown Parser available for Python.
- Intuitive - Great IDE support as it ships with stubs out of the box.
- Standards - Based on CMark C library which is fully compliant with the markdown spec.
- Command Line Interface - Ships with a Cli based on click for Cli usage.
- Support - Fully supported on Windows, Linux, MacOS.
Installation ✔¶
- Install Ultra Markdown with pip:
$ python -m pip install umarkdown
- Install Ultra Markdown with cli with pip:
$ python -m pip install umarkdown[cli]
Installation from source ✔¶
Prerequisites¶
- Compiler: gcc or clang on Linux and MacOS, MSVC for Windows.
- Python: 3.8 or greater
Installation Process¶
- Clone the repository:
$ git clone --recursive https://github.com/kumaraditya303/umarkdown
- Install requirements with pip:
$ pip install -r requirements.txt
- Build extensions and install:
$ pip install -e .[cli]
Usage 🚀¶
Can be used as a drop in replacement for most Markdown parsers.
>>> from umarkdown import markdown
>>> print(markdown("# Hello World!"))
<h1>Hello World!</h1>
License 📜¶
This project is licensed under BSD 3-Clause License.