https://github.com/frostming/marko
A markdown parser with high extensibility.
https://github.com/frostming/marko
commonmark extensible markdown parser regexp
Last synced: 27 days ago
JSON representation
A markdown parser with high extensibility.
- Host: GitHub
- URL: https://github.com/frostming/marko
- Owner: frostming
- License: mit
- Created: 2018-08-06T01:19:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-26T00:00:51.000Z (about 2 months ago)
- Last Synced: 2025-05-12T06:51:46.118Z (29 days ago)
- Topics: commonmark, extensible, markdown, parser, regexp
- Language: Python
- Homepage: https://marko-py.readthedocs.io/
- Size: 965 KB
- Stars: 391
- Watchers: 7
- Forks: 38
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 𝓜𝓪𝓻𝓴𝓸
> A markdown parser with high extensibility.
[](https://pypi.org/project/marko/)
[](https://pypi.org/project/marko/)
[](https://marko-py.readthedocs.io/en/latest/?badge=latest)
[][spec]
[](https://codecov.io/gh/frostming/marko)
[](https://www.codacy.com/app/frostming/marko?utm_source=github.com&utm_medium=referral&utm_content=frostming/marko&utm_campaign=Badge_Grade)
Marko is a pure Python markdown parser that adheres to the specifications of [CommonMark's spec v0.31.2][spec]. It has been designed with high extensibility in mind, as detailed in the [Extensions](#extensions) section.
Marko requires Python 3.8 or higher.
## Why Marko
Of all the Python markdown parsers available, a common issue is the difficulty for users to add their own features. Additionally, both [Python-Markdown][pymd] and [mistune][mistune] do not comply with CommonMark specifications. This has prompted me to develop a new markdown parser.
Marko's compliance with the complex CommonMark specification can impact its performance. However, using a parser that does not adhere to this spec may result in unexpected rendering outcomes. According to benchmark results, Marko is three times slower than Python-Markdown but slightly faster than Commonmark-py and significantly slower than mistune. If prioritizing performance over spec compliance is crucial for you, it would be best to opt for another parser.
[spec]: https://spec.commonmark.org/0.31.2/
[pymd]: https://github.com/waylan/Python-Markdown
[mistune]: https://github.com/lepture/mistune
[cmpy]: https://github.com/rtfd/CommonMark-py
## Use Marko
The installation is very simple:
$ pip install marko
And to use it:
```python
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:
```python
from marko import Markdown
from marko.ext.footnote import make_extension
# Add footnote extension
markdown = Markdown(extensions=[make_extension()])
# Or you can just:
markdown = Markdown(extensions=['footnote'])
# Alternatively you can register an extension later
markdown.use(make_extension())
```
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](https://marko-py.readthedocs.io/en/latest/extend.html) about how to
write your own extension.
## License
Marko is released under [MIT License](LICENSE)
## [Change Log](CHANGELOG.md)