Skip to main content

Marko

A markdown parser with high extensibility.

Build Status PyPI Documentation Status

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 Python 3.4 or higher, Python 2.7 support is still in plan but I guess it is not needed.

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.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.3.2

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.3.2
File Size Uploaded
marko-0.3.2.tar.gz 24.8 kB Details

Built distribution (wheel)

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

Total release size: 58.5 kB

Release files / marko-0.3.2.tar.gz

Download URL marko-0.3.2.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
cf8651b16e218d40a74a801b11bd8db70343e31722265cacd9966e143075cd6a
BLAKE2b-256 checksum
How to use checksums
09bcd55954d58775f028f5f1b3a484a37480cbf3b026b7fa2e4079a2b0ebcb6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

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

Download URL marko-0.3.2-py2.py3-none-any.whl
Size 33.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
928bac2d5c68fc62da722f73e3ab8c16b3abb5644bd9675c66246a470995f90e
BLAKE2b-256 checksum
How to use checksums
8fb7bef6aaa177ae3cd3771b5fe356676e31b950452404b35519df28545c4e70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

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

0.4.3

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

This release

0.3.2 This release

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