Need help with markdown-it-py?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

executablebooks
221 Stars 28 Forks MIT License 227 Commits 21 Opened issues

Description

Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. Now in Python!

Services available

!
?

Need anything else?

Contributors list

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[plugins]

or with extras

conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins
pip install markdown-it-py[linkify,plugins]

Usage

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 mdit_py_plugins.front_matter import front_matter_plugin
from mdit_py_plugins.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)

To export the html to a file, uncomment the lines below:

from pathlib import Path

Path("output.html").write_text(html_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

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 ...

Example

markdown input

Batch:

$ 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.