blob: a7f855029b61a7e553c5a30cd06cf4de277c0c94 [file] [log] [blame] [view]
[Python-Markdown][]
===================
[![Build Status](http://img.shields.io/travis/waylan/Python-Markdown.svg)](https://travis-ci.org/waylan/Python-Markdown)
[![Coverage Status](https://img.shields.io/coveralls/waylan/Python-Markdown.svg)](https://coveralls.io/r/waylan/Python-Markdown?branch=master)
[![Downloads](http://img.shields.io/pypi/dm/Markdown.svg)](https://pypi.python.org/pypi/Markdown#downloads)
[![Latest Version](http://img.shields.io/pypi/v/Markdown.svg)](http://pypi.python.org/pypi/Markdown)
[![BSD License](http://img.shields.io/badge/license-BSD-yellow.svg)](http://opensource.org/licenses/BSD-3-Clause)
This is a Python implementation of John Gruber's [Markdown][].
It is almost completely compliant with the reference implementation,
though there are a few known issues. See [Features][] for information
on what exactly is supported and what is not. Additional features are
supported by the [Available Extensions][].
[Python-Markdown]: https://pythonhosted.org/Markdown/
[Markdown]: http://daringfireball.net/projects/markdown/
[Features]: https://pythonhosted.org/Markdown/index.html#Features
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html
Documentation
-------------
Installation and usage documentation is available in the `docs/` directory
of the distribution and on the project website at
<https://pythonhosted.org/Markdown/>.
Support
-------
You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][].
[mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss
[bug tracker]: http://github.com/waylan/Python-Markdown/issues