Skip to main content

A markdown parser with high extensibility.

Project description

𝓜𝓪𝓻𝓴𝓸

A markdown parser with high extensibility.

PyPI PyPI - Python Version Documentation Status CommonMark Spec

Build Status AppVeyor Status codecov Codacy Badge

Marko is a markdown parser written in pure Python that complies CommonMark's spec v0.29. It is designed to be highly extensible, see Extend Marko for details.

Marko requires Python2.7, Python 3.5 or higher.

Why Marko

Among all implementations of Python's markdown parser, it is a common issue that user can't easily extend it to add his own features. Furthermore, Python-Markdown and mistune don't comply CommonMark's spec. It is a good reason for me to develop a new markdown parser.

Respecting that Marko complies CommonMark's spec at the same time, which is a super complicated spec, Marko's performance will be affected. However, using a parser which doesn't comply the CommonMark spec may give you unexpected rendered results from time to time. A benchmark result shows that Marko is 3 times slower than Python-Markdown, but a bit faster than Commonmark-py, much slower than mistune. If performance is a bigger concern to you than spec compliance, you'd better choose another parser.

Use Marko

The installation is very simple:

$ pip install marko

And to use it:

import marko

print(marko.convert(text))

Marko also provides a simple CLI, for example, to render a document and output to a html file:

$ cat my_article.md | marko > my_article.html

Extensions

It is super easy to use an extension:

from marko import Markdown
from marko.ext.footnote import FootnoteExtension
# Add footnote extension
markdown = Markdown(extensions=[FootnoteExtension])
# Alternatively you can register an extension later
markdown.use(FootnoteExtension)

Marko is shipped with 3 extensions: marko.ext.toc.TocExtension, marko.ext.footnote.FootnoteExtension, marko.ext.pangu.PanguExtension. They are not included in CommonMark's spec but are common in other markdown parsers.

Marko also provides a Github flavored markdown parser which can be found at marko.ext.gfm.gfm.

Please refer to Extend Marko about how to write your own extension.

License

Marko is released under MIT License

Change Log

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for marko, version 0.7.1
Filename, size File type Python version Upload date Hashes
Filename, size marko-0.7.1-py2.py3-none-any.whl (33.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size marko-0.7.1.tar.gz (30.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page