diff options
author | Waylan Limberg <waylan@gmail.com> | 2012-03-07 09:35:40 -0500 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2012-03-07 09:35:40 -0500 |
commit | ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch) | |
tree | 9c1b9c5025948204e415a21938469bf50bbae754 /docs/extensions/footnotes.md | |
parent | 9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff) | |
download | markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2 markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip |
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.
Diffstat (limited to 'docs/extensions/footnotes.md')
-rw-r--r-- | docs/extensions/footnotes.md | 68 |
1 files changed, 0 insertions, 68 deletions
diff --git a/docs/extensions/footnotes.md b/docs/extensions/footnotes.md deleted file mode 100644 index 1d6593c..0000000 --- a/docs/extensions/footnotes.md +++ /dev/null @@ -1,68 +0,0 @@ -title: Footnotes Extension -prev_title: Fenced Code Block Extension -prev_url: fenced_code_blocks.html -next_title: Tables Extension -next_url: tables.html - -Footnotes -========= - -Summary -------- - -An extension to Python-Markdown that adds footnote syntax. This extension has -been included with Python-Markdown since 1.7 and should be available to anyone -who has a typical install of Python-Markdown. - -Syntax ------- - -Python-Markdown's Footnote syntax follows the generally accepted syntax of the -Markdown community at large and almost exactly matches [PHP Markdown Extra][]'s -implementation of footnotes. The only differences involve a few subtleties in -the output. - -[PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/#footnotes - -Example: - - Footnotes[^1] have a label[^label] and a definition[^!DEF]. - - [^1]: This is a footnote - [^label]: A footnote on "label" - [^!DEF]: The definition of a footnote. - -A footnote definition may contain multiple lines, paragraphs, code blocks, -blockquotes and most any other markdown syntax. The additional line simply -must be indented at least an additional four spaces. - - [^1]: The first paragraph of the definition. - - Paragraph two of the definition. - - > A blockquote with - > multiple lines. - - a code block - - A final paragraph. - -By default, the footnote definitions are placed at the end of the resulting -HTML document. However, you may want the footnotes in another location within -the document. Simply place the following text at that location within your -markdown document (See how to configure this text below): - - ///Footnotes Go Here/// - -Usage ------ - -From the Python interpreter: - - >>> html = markdown.markdown(text, ['footnotes']) - -To configure the place marker for footnote definitions (just be sure not to -use any existing markdown syntax): - - >>> html = markdown.markdown(text, ['footnotes(PLACE_MARKER=+++my marker+++)']) - |