From ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 7 Mar 2012 09:35:40 -0500 Subject: Rename docs/*.md => docs/*.txt The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension. --- docs/extensions/index.txt | 63 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/extensions/index.txt (limited to 'docs/extensions/index.txt') diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt new file mode 100644 index 0000000..82b0eda --- /dev/null +++ b/docs/extensions/index.txt @@ -0,0 +1,63 @@ +title: Extensions +prev_title: Command Line +prev_url: ../cli.html +next_title: Extra Extension +next_url: extra.html + + +Available Extensions +==================== + +Python Markdown offers a flexible extension mechanism, which makes it possible +to change and/or extend the behavior of the parser without having to edit the +actual source files. + +To use an extension, pass it's name to markdown with the `extensions` keyword. +See the [Library Reference](../reference.html#extensions) for more details. + + markdown.markdown(some_text, extensions=['extra', 'nl2br']) + +From the command line, specify an extension with the `-x` option. See the +[Command Line docs](../cli.html) or use the `--help` option for more details. + + python -m markdown -x extra input.txt > output.html + +Officially Supported Extensions +------------------------------- + +The extensions listed below are included with (at least) the most recent release +and are officially supported by Python-Markdown. Any documentation is +maintained here and all bug reports should be made to the project. If you +have a typical install of Python-Markdown, these extensions are already +available to you. + +* [Extra](extra.html) + * [Abbreviations](abbreviations.html) + * [Attribute Lists](attr_list.html) + * [Definition Lists](definition_lists.html) + * [Fenced Code Blocks](fenced_code_blocks.html) + * [Footnotes](footnotes.html) + * [Tables](tables.html) + * [Smart Strong](smart_strong.html) +* [CodeHilite](code_hilite.html) +* [HTML Tidy](html_tidy.html) +* [HeaderId](header_id.html) +* [Meta-Data](meta_data.html) +* [New Line to Break](nl2br.html) +* [RSS](rss.html) +* [Sane Lists](sane_lists.html) +* [Table of Contents](toc.html) +* [WikiLinks](wikilinks.html) + +Third Party Extensions +---------------------- + +Various individuals and/or organizations have developed extensions which they +have made available to the public. A [list of third party +extensions](https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions) +is maintained on the wiki for your convenience. The Python-Markdown team +offers no official support for these extensions. Please see the developer of +each extension for support. + +If you would like to write your own extensions, see the +[Extensions API](api.html) for details. -- cgit v1.2.3