A markdown parser with high extensibility.
Project description
Marko
A markdown parser with high extensibility.
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:
import marko
marko.markdown('A long 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
Note that the signature of marko.markdown():
def markdown(text, parser=Parser, renderer=HTMLRenderer):
...
You can supply your own parser or renderer to it.
- A parser is what parses the document into separated elements.
- A renderer is what renders given element into desired output, which can be HTML in the most common situation.
License
Marko is released under MIT License
Change Log
- v0.2.0: Github flavored markdown and docs.
- v0.1.0: Commonmark spec tests.
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-0.2.1.tar.gz.
File metadata
- Download URL: marko-0.2.1.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3d3b2d20af9e9b2889b2a2ec481d92380c6ac3e6afca7cc0ccca8043db9436c4 |
|
| MD5 | 17fddb318c15ad01bf701ea85ed81a91 |
|
| BLAKE2b-256 | 9f058542558b95d3439eb16e820d0b2e094c76920a003883670e9784488ddcc9 |
Provenance
File details
Details for the file marko-0.2.1-py2.py3-none-any.whl.
File metadata
- Download URL: marko-0.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 30.6 kB
- Tags: Python 2, Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5b4b4bafa1846594be6631fe78d70010bc976dffc62f5968a3ac1068bf60e4b5 |
|
| MD5 | 080833e2a94032a03c55a1e7bff27032 |
|
| BLAKE2b-256 | 25419241a8e60ca90a3024b1af961d58d853ca3ea1b9056bc92c725ac36d3f45 |
