aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/footnotes.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2011-08-23 10:53:49 -0400
committerWaylan Limberg <waylan@gmail.com>2011-08-23 10:53:49 -0400
commita6fd7b5cba69cad049046b3a372d0f2d6c495abe (patch)
tree42a8987d08eb5a05eb2b3cb1399540583e8cbf67 /docs/extensions/footnotes.txt
parente5b2813bbf02710c7deb148896085a3dac4828dc (diff)
downloadmarkdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.gz
markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.tar.bz2
markdown-a6fd7b5cba69cad049046b3a372d0f2d6c495abe.zip
Renamed *.txt -> *.md in docs.
Diffstat (limited to 'docs/extensions/footnotes.txt')
-rw-r--r--docs/extensions/footnotes.txt62
1 files changed, 0 insertions, 62 deletions
diff --git a/docs/extensions/footnotes.txt b/docs/extensions/footnotes.txt
deleted file mode 100644
index 7188f44..0000000
--- a/docs/extensions/footnotes.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-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+++)'])
-