diff options
author | Tiago Serafim <tserafim@gmail.com> | 2013-02-09 16:51:17 -0200 |
---|---|---|
committer | Tiago Serafim <tserafim@gmail.com> | 2013-02-09 17:39:12 -0200 |
commit | 14f43d5a4c91ac13528f4c9eb8c6247fdafb0ea1 (patch) | |
tree | edcb6d7462d31d66dcc792ed5e84373187b1de14 /docs/extensions | |
parent | 6c15c64df40b9ded3f5dea2e694905222791c1b6 (diff) | |
parent | 41cc055580d63ffb7eb2bbb6c88e121727d91d06 (diff) | |
download | markdown-14f43d5a4c91ac13528f4c9eb8c6247fdafb0ea1.tar.gz markdown-14f43d5a4c91ac13528f4c9eb8c6247fdafb0ea1.tar.bz2 markdown-14f43d5a4c91ac13528f4c9eb8c6247fdafb0ea1.zip |
Merge branch 'master' into admonition
Conflicts:
docs/extensions/index.txt
tests/extensions/test.cfg
Diffstat (limited to 'docs/extensions')
-rw-r--r-- | docs/extensions/attr_list.txt | 2 | ||||
-rw-r--r-- | docs/extensions/index.txt | 75 | ||||
-rw-r--r-- | docs/extensions/wikilinks.txt | 2 |
3 files changed, 57 insertions, 22 deletions
diff --git a/docs/extensions/attr_list.txt b/docs/extensions/attr_list.txt index 11c6a28..4134a82 100644 --- a/docs/extensions/attr_list.txt +++ b/docs/extensions/attr_list.txt @@ -73,7 +73,7 @@ The above results in the following output: To define attributes on inline elements, the attribute list should be defined immediately after the inline element with no whitespace. - [link](http://example.com){: class="foo bar" title="Some title! } + [link](http://example.com){: class="foo bar" title="Some title!" } The above results in the following output: diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt index 610fe21..c9ee005 100644 --- a/docs/extensions/index.txt +++ b/docs/extensions/index.txt @@ -15,12 +15,12 @@ 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']) + markdown.markdown(some_text, extensions=['footnotes', '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 + python -m markdown -x footnotes -x tables input.txt > output.html Officially Supported Extensions ------------------------------- @@ -31,24 +31,59 @@ 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) -* [Admonition](admonition.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) +### Markdown Extra + +You can enable **all** these extensions just as if it was a single +`extra` extension. Example: + + markdown.markdown(some_text, extensions=['extra', 'codehilite']) + +Extension | Name in Python-Markdown +--------- | ----------------------- +[Abbreviations][] | `abbr` +[Attribute Lists][] | `attr_list` +[Definition Lists][] | `def_list` +[Fenced Code Blocks][] | `fenced_code` +[Footnotes][] | `footnotes` +[Tables][] | `tables` +[Smart Strong][] | `smart_strong` + +[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 + +### Other extensions + +There are also some extensions that are not included in Markdown Extra +but come in the standard Python-Markdown library. + +Extension | Name in Python-Markdown +--------- | ----------------------- +[Admonition][] | `admonition` +[CodeHilite][] | `codehilite` +[HTML Tidy][] | `html_tidy` +[HeaderId] | `headerid` +[Meta-Data] | `meta` +[New Line to Break] | `nl2br` +[RSS] | `rss` +[Sane Lists] | `sane_lists` +[Table of Contents] | `toc` +[WikiLinks] | `wikilinks` + +[Admonition]: admonition.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 ---------------------- diff --git a/docs/extensions/wikilinks.txt b/docs/extensions/wikilinks.txt index b5e2b04..5f6d20e 100644 --- a/docs/extensions/wikilinks.txt +++ b/docs/extensions/wikilinks.txt @@ -99,7 +99,7 @@ could also pass in a callable which must accept three arguments (``label``, The option is also provided to change or remove the class attribute. >>> html = markdown.markdown(text, - ... ['wikilink(base_url=myclass)'] + ... ['wikilink(html_class=myclass)'] ... ) Would cause all wikilinks to be assigned to the class `myclass`. |