Skip to content

Installation

Requirements

In order for PyMdown Extensions to work, there are a couple of prerequisites.

Name Required Details
Python Markdown Yes Python Markdown must be installed as it is the Markdown parser that is being used.
Pygments (optional) No If Pygments Syntax highlighting is desired, Pygments must be installed. This can be omitted, and code blocks will be formatted for use with JavaScript code highlighters.

Installation

Installation is easy with pip:

$ pip install pymdown-extensions

If you want to manually install it, run:

$ python setup.py build
$ python setup.py install

After installing, you should be able to access the extensions in Python Markdown under the namespace pymdownx.<extension>.

If you would like to modify the code, you can install it via:

$ pip install --editable .

This method will allow you to instantly see your changes without reinstalling. If you want to do this in a virtual machine, you can.


Last update: April 18, 2020