diff options
author | Waylan Limberg <waylan.limberg@icloud.com> | 2017-12-06 23:18:29 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-12-06 23:18:29 -0500 |
commit | b62ddeda02fadcd09def9354eb2ef46a7562a106 (patch) | |
tree | 37149361ca1eeb8c24942835b2f933105fa920ed /docs/extensions/index.txt | |
parent | de5c696f94e8dde242c29d4be50b7bbf3c17fedb (diff) | |
download | markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.gz markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.bz2 markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.zip |
Switch docs to MKDocs (#602)
Fixes #601. Merged in 6f87b32 from the md3 branch and did a lot of cleanup.
Changes include:
* Removed old docs build tool, templates, etc.
* Added MkDocs config file, etc.
* filename.txt => filename.md
* pythonhost.org/Markdown => Python-Markdown.github.io
* Markdown lint and other cleanup.
* Automate pages deployment in makefile with `mkdocs gh-deploy`
Assumes a git remote is set up named "pages". Do
git remote add pages https://github.com/Python-Markdown/Python-Markdown.github.io.git
... before running `make deploy` the first time.
Diffstat (limited to 'docs/extensions/index.txt')
-rw-r--r-- | docs/extensions/index.txt | 87 |
1 files changed, 0 insertions, 87 deletions
diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt deleted file mode 100644 index ba95274..0000000 --- a/docs/extensions/index.txt +++ /dev/null @@ -1,87 +0,0 @@ -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 to markdown with the `extensions` keyword. - - markdown.markdown(some_text, extensions=[MyExtension(), 'path.to.my.ext', 'markdown.extensions.footnotes']) - -See the [Library Reference](../reference.html#extensions) for more details. - -From the command line, specify an extension with the `-x` option. - - $ python -m markdown -x markdown.extensions.footnotes -x markdown.extensions.tables input.txt > output.html - -See the [Command Line docs](../cli.html) or use the `--help` option for more details. - -!!! seealso "See Also" - If you would like to write your own extensions, see the - [Extension API](api.html) for details. - -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 using the "name" listed in the second column below. - -Extension | "Name" ------------------------------------- | --------------- -[Extra] | `markdown.extensions.extra` - [Abbreviations][] | `markdown.extensions.abbr` - [Attribute Lists][] | `markdown.extensions.attr_list` - [Definition Lists][] | `markdown.extensions.def_list` - [Fenced Code Blocks][] | `markdown.extensions.fenced_code` - [Footnotes][] | `markdown.extensions.footnotes` - [Tables][] | `markdown.extensions.tables` - [Smart Strong][] | `markdown.extensions.smart_strong` -[Admonition][] | `markdown.extensions.admonition` -[CodeHilite][] | `markdown.extensions.codehilite` -[HeaderId] | `markdown.extensions.headerid` -[Meta-Data] | `markdown.extensions.meta` -[New Line to Break] | `markdown.extensions.nl2br` -[Sane Lists] | `markdown.extensions.sane_lists` -[SmartyPants] | `markdown.extensions.smarty` -[Table of Contents] | `markdown.extensions.toc` -[WikiLinks] | `markdown.extensions.wikilinks` - -[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 -[HeaderId]: header_id.html -[Meta-Data]: meta_data.html -[New Line to Break]: nl2br.html -[Sane Lists]: sane_lists.html -[SmartyPants]: smarty.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][list] -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. - -[list]: https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions |