A markdown parser with high extensibility.
Project description
𝓜𝓪𝓻𝓴𝓸
A markdown parser with high extensibility.
Marko is a markdown parser written in pure Python that complies with CommonMark's spec v0.30. It is designed to be highly extensible, see Extend Marko for details.
Marko requires Python 3.6 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 with CommonMark's spec. It is a good reason for me to develop a new markdown parser.
Respecting that Marko complies with 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 with 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file marko-1.1.0.tar.gz.
File metadata
- Download URL: marko-1.1.0.tar.gz
- Upload date:
- Size: 135.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 764316137a2f1ada070958870208ea5b6e4eda879ee4b743552aaebf9d0397f7 |
|
| MD5 | e6552ad672b95e61ac0dbefe3c11ebcd |
|
| BLAKE2b-256 | 86540be85840898205e3d9c684569e6625b3c7bb35db595dbcbb992375e13ef6 |
Provenance
File details
Details for the file marko-1.1.0-py3-none-any.whl.
File metadata
- Download URL: marko-1.1.0-py3-none-any.whl
- Upload date:
- Size: 35.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 151953cf41c3a76029c8b23368faf323a29d4788c7d1e0a1c64423f4ddedf68e |
|
| MD5 | a41e7135c365de9fd19480a1f7849323 |
|
| BLAKE2b-256 | 4b48f21089d2dd0dcd81070a1d07ad38df16074972d3411d2f88586dd1619684 |
