diff options
| author | Tiago Serafim <tserafim@gmail.com> | 2012-09-19 18:43:21 -0300 |
|---|---|---|
| committer | Tiago Serafim <tserafim@gmail.com> | 2012-09-19 18:43:21 -0300 |
| commit | 85e74fb710e64a35b3ed458bdec6cfed7827c3b1 (patch) | |
| tree | 0f036613cca208a1cb0505348f308d3d13bd908a /docs/extensions/index.txt | |
| parent | 9756cb9f6014347179a9acf54a739aad5dda0c6d (diff) | |
| download | markdown-85e74fb710e64a35b3ed458bdec6cfed7827c3b1.tar.gz markdown-85e74fb710e64a35b3ed458bdec6cfed7827c3b1.tar.bz2 markdown-85e74fb710e64a35b3ed458bdec6cfed7827c3b1.zip | |
First version of the docs.
Diffstat (limited to 'docs/extensions/index.txt')
| -rw-r--r-- | docs/extensions/index.txt | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt index 82b0eda..610fe21 100644 --- a/docs/extensions/index.txt +++ b/docs/extensions/index.txt @@ -8,16 +8,16 @@ 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. +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. +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 +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 @@ -26,9 +26,9 @@ 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 +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) @@ -39,6 +39,7 @@ available to you. * [Footnotes](footnotes.html) * [Tables](tables.html) * [Smart Strong](smart_strong.html) +* [Admonition](admonition.html) * [CodeHilite](code_hilite.html) * [HTML Tidy](html_tidy.html) * [HeaderId](header_id.html) @@ -53,11 +54,11 @@ Third Party Extensions ---------------------- Various individuals and/or organizations have developed extensions which they -have made available to the public. A [list of third party +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 +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 +If you would like to write your own extensions, see the [Extensions API](api.html) for details. |