Skip to main content

Marko

A markdown parser with high extensibility.

Build Status PyPI PyPI - Python Version Documentation Status codecov

Marko is a markdown parser written in pure Python that complies CommonMark's spec v0.28. 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 and use it.

Respecting that Marko complies CommonMark's spec at the same time, which is a super complicated spec, Marko's performance will be affected. 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's better choose another parser.

Use Marko

The installation is very simple:

$ pip install marko

And to use it:

from marko import Markdown
markdown = Markdown()
print(markdown(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

Extend Marko

Please refer to Document

License

Marko is released under MIT License

Change Log

  • v0.4.3: Fix TOC rendering when heading level exceeds the max depth.
  • v0.4.2: Fix CJK regexp for pangu extension.
  • v0.4.0: Support Python 2.7.
  • v0.3.4: Fix bugs about extensions.
  • v0.3.1: Pangu extension.
  • v0.3.0: Change the entry function to a class, add TOC and footnotes extensions.
  • v0.2.0: Github flavored markdown and docs.
  • v0.1.0: Commonmark spec tests.

Release files for marko 0.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for marko 0.4.3
File Size Uploaded
marko-0.4.3.tar.gz 24.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for marko 0.4.3
File Interpreter ABI Platform
marko-0.4.3-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 58.3 kB

Release files / marko-0.4.3.tar.gz

Download URL marko-0.4.3.tar.gz
Size 24.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bd302b831f706e6a290e0c659f4156e771b174227d7bd57f10f2b4f47f85a633
BLAKE2b-256 checksum
How to use checksums
7c165091192a6dea5c09d7b5c57bd26e6ff85e32b06d05d79f0b013d0fb45656
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0 requests/2.21.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/2.7.15

Release files / marko-0.4.3-py2.py3-none-any.whl

Download URL marko-0.4.3-py2.py3-none-any.whl
Size 34.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
48484404f515966a60f38156d1a6f6a8455b593370c9204ccea80b847569b4f2
BLAKE2b-256 checksum
How to use checksums
72456daa7813d67954f1a7518e1e82df5b3a7106d1f74f4ec0b61097706e3751
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0 requests/2.21.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/2.7.15

Release history Release notifications | RSS feed

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.10.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

This release

0.4.3 This release

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page