‼️ BREAKING: Align table parsing with GFM spec

Alter code such that parsing respects: https://github.github.com/gfm/#tables-extension-

 - table now doesn't deal with backticks at all
 - `|` is considered escaped if and only if there is a `\` character immediately before it
 - number of elements in the first row (thead) now must match second row (aligns) exactly
 - no `tbody` if it would be empty

Implements: https://github.com/markdown-it/markdown-it/commit/3021a5207bce6e4198ca86e406db02db5e4930b9
3 files changed
tree: e35cd5fe472df7bf4386de700a651bf6e5fc3186
  1. .flake8
  2. .github/
  3. .gitignore
  4. .mypy.ini
  5. .pre-commit-config.yaml
  6. .readthedocs.yml
  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


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:


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


pip install markdown-it-py


Python API Usage

Render markdown to HTML with markdown-it-py and a custom configuration with and without plugins and features:

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

md = (
text = ("""
a: 1

a | b
- | -
1 | 2

A footnote [^1]

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

Command-line Usage

Render markdown to HTML with markdown-it-py from the command-line:

usage: markdown-it [-h] [-v] [filenames [filenames ...]]

Parse one or more markdown files, convert each to HTML, and print to stdout

positional arguments:
  filenames      specify an optional list of files to convert

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit


  $ markdown-it
  markdown-it-py [version 0.0.0] (interactive)
  Type Ctrl-D to complete input, or Ctrl-C to exit.
  >>> # Example
  ... > markdown *input*
  <p>markdown <em>input</em></p>


  $ markdown-it README.md README.footer.md > index.html

References / Thanks

Big thanks to the authors of markdown-it:

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