mizu 💧

Mizu is markdown parser, written by rust and used pulldown-cmark.

Installation

pip install mizu

Or

pip install "mizu @ git+https://github.com/tuna2134/mizu"

Examples

from mizu import parse


parse("# Hello tuna2134")

Extension:

from mizu import parse_ext


parse_ext("""
- [ ] test
- [ ] test2
""")

API Reference

parse

This function is parse markdown to html.

PARAMETERS: text (str) – Markdown content.

RETURNS: Html content.

RETURN TYPE: str

parse_ext

This function is parse markdown to html.

PARAMETERS: text (str) – Markdown content. tables (Optional[bool]) – Enable tables. footnotes (Optional[bool]) – Enable footnotes. strikethrough (Optional[bool]) – Enable strikethrough. tasklists (Optional[bool]) – Enable tasklists. smart_punctuation (Optional[bool]) – Enable smart_punctuation. heading_attribute (Optional[bool]) – Enable heading_attribute.

RETURNS: Html content.

RETURN TYPE: str