Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

Python-Markdown extension to allow for subscript text.

Project Description

Latest Release:




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
Release History

Release History

This version
History Node


History Node


Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting