|
| 1 | +Python-Markdown |
| 2 | +=============== |
| 3 | + |
| 4 | +This is a Python implementation of John Gruber's |
| 5 | +[Markdown](http://daringfireball.net/projects/markdown/). |
| 6 | +It is almost completely compliant with the reference implementation, |
| 7 | +though there are a few very minor differences. See John's |
| 8 | +[Syntax Documentation](http://daringfireball.net/projects/markdown/syntax) |
| 9 | +for the syntax rules. |
| 10 | + |
| 11 | +See the [installation instructions](install.html) to get started. |
| 12 | + |
| 13 | +Features |
| 14 | +-------- |
| 15 | + |
| 16 | +In addition to the basic markdown syntax, Python-Markdown supports the following |
| 17 | +features: |
| 18 | + |
| 19 | +* International Input |
| 20 | + |
| 21 | + Python-Markdown will accept input in any language supported by Unicode |
| 22 | + including bi-directional text. In fact the test suite includes documents |
| 23 | + written in Russian and Arabic. |
| 24 | + |
| 25 | +* Middle-Word Emphasis |
| 26 | + |
| 27 | + Python-Markdown defaults to ignoring middle-word emphasis. In other words, |
| 28 | + `some_long_filename.txt` will not become `some<em>long</em>filename.txt`. |
| 29 | + This can be switched off if desired. See the |
| 30 | + [Library Reference](using_as_module.html) for details. |
| 31 | + |
| 32 | +* Extensions |
| 33 | + |
| 34 | + Various [extensions](extensions.html) are provided (including |
| 35 | + [extra](extensions/extra.html)) to expand the base syntax. Additionally, |
| 36 | + a public [Extension API](writing_extensions.html) is available to write |
| 37 | + your own extensions. |
| 38 | + |
| 39 | +* Output Formats |
| 40 | + |
| 41 | + Python-Markdown can output documents in HTML4, XHTML and HTML5. |
| 42 | + |
| 43 | +* "Safe Mode" |
| 44 | + |
| 45 | + When using Python-Markdown to parse input from untrusted users on the web, |
| 46 | + the handling of raw HTML can be controlled in various ways to prevent |
| 47 | + harmful code from being injected into your site. |
| 48 | + |
| 49 | +* Command Line Interface |
| 50 | + |
| 51 | + In addition to being a Python Library, a |
| 52 | + [command line script](command_line.html) is available for your convenience. |
| 53 | + |
| 54 | +Support |
| 55 | +------- |
| 56 | + |
| 57 | +You may ask for help and discuss various other issues on the [mailing list][] |
| 58 | +and report bugs on the [bug tracker][]. |
| 59 | + |
| 60 | +[mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss |
| 61 | +[bug tracker]: http://github.com/waylan/Python-Markdown/issues |
0 commit comments