Skip to main content

A markdown parser with high extensibility.

Reason this release was yanked:

security issue

Project description

𝓜𝓪𝓻𝓴𝓸

A markdown parser with high extensibility.

PyPI PyPI - Python Version Documentation Status CommonMark Spec

Build 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 Footnote
# Add footnote extension
markdown = Markdown(extensions=[Footnote])
# Or you can just:
markdown = Markdown(extensions=['footnote'])
# Alternatively you can register an extension later
markdown.use(Footnote)

An example of using an extension with the command-line version of Marko:

$ cat this_has_footnote.txt | marko -e footnote > hi_world.html

Marko is shipped with 4 extensions: 'footnote', 'toc' 'pangu', 'codehilite'. 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.

Source Distribution

marko-0.9.0.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

marko-0.9.0-py2.py3-none-any.whl (35.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file marko-0.9.0.tar.gz.

File metadata

  • Download URL: marko-0.9.0.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for marko-0.9.0.tar.gz
Algorithm Hash digest
SHA256 0927f48c7ed895cf5bba228d9b4b4f7ebc666428804b59ea8b87098032458a0a
MD5 3d49ba18a539877b9888844e8ae6742e
BLAKE2b-256 465b06136130094eec3e418a61e64bc91ffda6dc39f1621096039fac53d8d04a

See more details on using hashes here.

Provenance

File details

Details for the file marko-0.9.0-py2.py3-none-any.whl.

File metadata

  • Download URL: marko-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for marko-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0b9a2bd63a9da90ef3d8db3c4c37f76716f42599871d748ff0aeb2be8fe9a1f0
MD5 7ced2844f573e9f09c6743861ef10319
BLAKE2b-256 78876baf8d719763228eb0959a639036c566787d1deb3b1a4a95dfd302b5b2af

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page