Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
markdown2: A fast and complete implementation of Markdown in Python
branch: master

This branch is 185 commits behind trentm:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
externals
lib
perf
sandbox
test
.gitignore
CHANGES.txt
CONTRIBUTORS.txt
LICENSE.txt
MANIFEST.in
Makefile.py
README.md
TODO.txt
setup.py

README.md

Markdown is a light text markup format and a processor to convert that to HTML. The originator describes it as follows:

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

-- http://daringfireball.net/projects/markdown/

This is a fast and complete Python implementation of Markdown. It was written to closely match the behaviour of the original Perl-implemented Markdown.pl. There is another Python markdown.py. However, at least at the time this project was started, markdown2.py was faster (see the Performance Notes) and, to my knowledge, more correct (see Testing Notes). That was a while ago though, so you should still consider Python-markdown for your usage.

Install

To install it in your Python installation run one of the following:

pypm install markdown2      # if you use ActivePython (activestate.com/activepython)
pip install markdown2
python setup.py install

However, everything you need to run this is in "lib/markdown2.py". If it is easier for you, you can just copy that file to somewhere on your PythonPath (to use as a module) or executable path (to use as a script).

Quick Usage

As a module:

>>> import markdown2
>>> markdown2.markdown("*boo!*")  # or use `html = markdown_path(PATH)`
u'<p><em>boo!</em></p>\n'

>>> markdowner = Markdown()
>>> markdowner.convert("*boo!*")
u'<p><em>boo!</em></p>\n'
>>> markdowner.convert("**boom!**")
u'<p><strong>boom!</strong></p>\n'

As a script:

$ python markdown2.py foo.txt > foo.html

See the project wiki, lib/markdown2.py docstrings and/or python markdown2.py --help for more details.

Project

The python-markdown2 project lives at https://github.com/trentm/python-markdown2/. (Note: On Mar 6, 2011 this project was moved from Google Code to here on Github.) See also, markdown2 on the Python Package Index (PyPI).

The change log: https://github.com/trentm/python-markdown2/blob/master/CHANGES.txt

To report a bug: https://github.com/trentm/python-markdown2/issues

Test Suite

This markdown implementation passes a fairly extensive test suite. To run it:

cd test && python test.py

If you have the mk tool installed you can run the test suite with all available Python versions by running:

mk test

The crux of the test suite is a number of "cases" directories -- each with a set of matching .text (input) and .html (expected output) files. These are:

tm-cases/                   Tests authored for python-markdown2 (tm=="Trent Mick")
markdowntest-cases/         Tests from the 3rd-party MarkdownTest package
php-markdown-cases/         Tests from the 3rd-party MDTest package
php-markdown-extra-cases/   Tests also from MDTest package

See the Testing Notes wiki page for full details.

Something went wrong with that request. Please try again.