Skip to main content

Python-Markdown extension to allow for subscript text.

Project description

Latest Release: PyPI Version

Compatibility: Python Implementation Support Python Support License

Tests: Build Status Coverage Status Requirements Status

Read Me

An extension to the Python Markdown project which adds the ability to subscript text. To do so, the character ~ becomes a Markdown tag for text meant to be subscripted, and is replaced with the HTML sub tag.

For example, given the text:

The molecular composition of water is H~2~O.

… using Markdown with this extension will output:

<p>The molecular composition of water is H<sub>2</sub>O.</p>

This project is provided under the Simplified (2 Clause) BSD license, provided in full in the LICENSE file.



  • Python 2.7, 3.3+
  • Markdown 2.5+ (Tested against latest patch version of Markdown 2.5 and 2.6)

To install the latest stable release (recommended):

pip install MarkdownSubscript

To install the development version:

pip install git+git://

Basic Usage


>>> from markdown import markdown
>>> text = "The molecular composition of water is H~2~O."
>>> markdown(text, ['subscript'])
'<p>The molecular composition of water is H<sub>2</sub>O.</p>'

Command Line

$ echo 'The molecular composition of water is H~2~O.' >
$ python -m markdown -o html5 -x 'subscript' -f text.html

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
MarkdownSubscript-2.0.0-py2.py3-none-any.whl (5.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Apr 17, 2017
MarkdownSubscript-2.0.0.tar.gz (4.4 kB) Copy SHA256 hash SHA256 Source None Apr 17, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page