README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

Python-Markdown
===============

[![Build Status](https://travis-ci.org/Python-Markdown/markdown.svg?branch=master)](https://travis-ci.org/Python-Markdown/markdown)
[![Coverage Status](https://coveralls.io/repos/Python-Markdown/markdown/badge.svg?branch=master)](https://coveralls.io/r/Python-Markdown/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)

***WARNING:*** This is **alpha** software. This is the development repo for the upcoming version 3.0. 
For a stable version of Python-Markdown see the 2.x repo at [waylan/Python-Markdown].
If you are interested in what changes to expect in 3.0 you may want to checkout the [roadmap].
If you would like to help, pull requests are welcome. If you would like to discuss future features
and/or changes, start a discussion on the [mailing list].

[waylan/Python-Markdown]: https://github.com/waylan/Python-Markdown
[roadmap]: https://github.com/waylan/Python-Markdown/issues/391

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][].

[Markdown]: http://daringfireball.net/projects/markdown/
[Features]: https://pythonhosted.org/Markdown/index/#Features
[Available Extensions]: https://pythonhosted.org/Markdown/extensions/


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/Python-Markdown/markdown/issues