Markdown parser done right.
- Follows the CommonMark spec for baseline parsing
- Configurable syntax: you can add new rules and even replace existing ones.
- Pluggable: Adds syntax extensions to extend the parser (see the plugin list).
- High speed (see our benchmarking tests)
- Easy to configure for security
- Member of Google's Assured Open Source Software
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:
See also: markdown-it-pyrs for an experimental Rust binding, for even more speed!
pip install markdown-it-py[plugins]
or with extras
pip install markdown-it-py[linkify,plugins]
conda install -c conda-forge markdown-it-py
or with extras
conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins
Render markdown to HTML with markdown-it-py and a custom configuration with and without plugins and features:
from markdown_it import MarkdownIt from mdit_py_plugins.front_matter import front_matter_plugin from mdit_py_plugins.footnote import footnote_plugin md = ( MarkdownIt("commonmark", {"breaks": True, "html": True}) .use(front_matter_plugin) .use(footnote_plugin) .enable("table") ) text = """ --- a: 1 --- a | b - | - 1 | 2 A footnote [^1] [^1]: some details """ tokens = md.parse(text) html_text = md.render(text) ## To export the html to a file, uncomment the lines below: # from pathlib import Path # Path("output.html").write_text(html_text)
Render markdown to HTML with markdown-it-py from the command-line:
usage: markdown-it [-h] [-v] [--stdin] [--enable-tables] [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 options: -h, --help show this help message and exit -v, --version show program's version number and exit --stdin read Markdown from standard input --enable-tables enable table parsing Interactive: $ markdown-it markdown-it-py [version 0.0.0] (interactive) Type Ctrl-D to complete input, or Ctrl-C to exit. >>> # Example ... > markdown *input* ... <h1>Example</h1> <blockquote> <p>markdown <em>input</em></p> </blockquote> Batch: $ markdown-it README.md README.footer.md > index.html
In interactive mode, end each input with Ctrl-D, or on Windows with Ctrl-Z then Enter (the prompt names the keys for your platform).
Tables are disabled by default, as in CommonMark.
Use --enable-tables with any input mode to enable them:
markdown-it --enable-tables README.md > index.html markdown-it --enable-tables --stdin < README.md > index.html markdown-it --enable-tables
Big thanks to the authors of markdown-it:
- Alex Kocharin github/rlidwka
- Vitaly Puzrin github/puzrin
Also John MacFarlane for his work on the CommonMark spec and reference implementations.