Merge branch 'master' into add-test-dollar_math
tree: 99c78ae472f520ed376b1f73e92561b7c04d5f9e
  1. .circleci/
  2. .flake8
  3. .github/
  4. .gitignore
  5. .pre-commit-config.yaml
  6. .readthedocs.yml
  7. CHANGELOG.md
  8. LICENSE
  9. LICENSE.markdown-it
  10. MANIFEST.in
  11. README.md
  12. benchmarking/
  13. codecov.yml
  14. docs/
  15. docstring.fmt.mustache
  16. markdown_it/
  17. setup.py
  18. tests/
  19. tox.ini
README.md

markdown-it-py

Github-CI Coverage Status PyPI Conda Code style: black PyPI - Downloads

Markdown parser done right.

This is a Python port of markdown-it, and some of its associated plugins. For more details see: https://markdown-it-py.readthedocs.io.

For details on markdown-it itself, see:

Installation

conda install -c conda-forge markdown-it-py

or

pip install markdown-it-py

Basic usage

from markdown_it import MarkdownIt
from markdown_it.extensions.front_matter import front_matter_plugin
from markdown_it.extensions.footnote import footnote_plugin

md = (
    MarkdownIt()
    .use(front_matter_plugin)
    .use(footnote_plugin)
    .disable('image')
    .enable('table')
)
text = ("""
---
a: 1
---

a | b
- | -
1 | 2

A footnote [^1]

[^1]: some details
""")
tokens = md.parse(text)
html_text = md.render(text)

Also you can use it from the command-line:

$ markdown-it
markdown-it-py [version 0.1.0] (interactive)
Type Ctrl-D to complete input, or Ctrl-C to exit.
>>> > **hallo** there!
...
<blockquote>
<p><strong>hallo</strong> there!</p>
</blockquote>

References / Thanks

Big thanks to the authors of markdown-it:

Also John MacFarlane for his work on the CommonMark spec and reference implementations.