diff options
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 0000000..d19a1ea --- /dev/null +++ b/docs/README @@ -0,0 +1,30 @@ +[Python-Markdown][] +=================== + +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]: http://freewisdom.org/projects/python-markdown +[Markdown]: http://daringfireball.net/projects/markdown/ +[Features]: http://www.freewisdom.org/projects/python-markdown/Features +[Available Extensions]: http://www.freewisdom.org/projects/python-markdown/Available_Extensions + + +Documentation +------------- + +Installation and usage documentation is available in the `docs/` directory +of the distribution and on the project website at +<http://freewisdom.org/projects/python-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://www.freewisdom.org/projects/python-markdown/Tickets + |