Skip to main content

Python-Markdown extension to allow for superscript 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 superscript text. To do so, the character ^ becomes a Markdown tag for text meant to be superscripted, and is replaced with the HTML sup tag.

For example, given the text:

2^10^ is 1024.

… using Markdown with this extension will output:

<p>2<sup>10</sup> is 1024.</p>

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

Installation

Dependencies:

  • 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 MarkdownSuperscript

To install the development version:

pip install git+git://github.com/jambonrose/markdown_superscript_extension.git

Basic Usage

Python

>>> from markdown import markdown
>>> text = "2^10^ is 1024."
>>> markdown(text, ['superscript'])
'<p>2<sup>10</sup> is 1024.</p>'

Command Line

$ echo '2^10^ is 1024.' > text.md
$ python -m markdown -o html5 -x 'superscript' -f text.html text.md

Download files

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

Source Distribution

MarkdownSuperscript-2.0.0.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

MarkdownSuperscript-2.0.0-py2.py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page