aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/footnotes.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/extensions/footnotes.txt')
-rw-r--r--docs/extensions/footnotes.txt29
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/extensions/footnotes.txt b/docs/extensions/footnotes.txt
index 1d6593c..e06344b 100644
--- a/docs/extensions/footnotes.txt
+++ b/docs/extensions/footnotes.txt
@@ -26,17 +26,30 @@ the output.
Example:
- Footnotes[^1] have a label[^label] and a definition[^!DEF].
+ Footnotes[^1] have a label[^@#$%] and the footnote's content.
- [^1]: This is a footnote
- [^label]: A footnote on "label"
- [^!DEF]: The definition of a footnote.
+ [^1]: This is a footnote's content.
+ [^@#$%]: A footnote on the label: "@#$%".
-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.
+A footnote label must start with a caret `^` and may contain any inline text
+(including spaces) between a set of square brackets `[]`. Only the first
+caret has any special meaning.
- [^1]: The first paragraph of the definition.
+A footnote's content must start with the label followed by a colon and at least
+one space. The label used to define the content must exactly match the label used
+in the body (including capitalization and whitespace). The content would then
+follow the label either on the same line or on the next line. The content may
+contain multiple lines, paragraphs, code blocks, blockquotes and most any other
+markdown syntax. The additional lines must be indented one level (four spaces or
+one tab).
+
+When working with multiple blocks, it may be helpful to start the content on a
+separate line from the label which defines the content. This way the entire block
+is indented consistently and any errors are more easily discernible by the author.
+
+
+ [^1]:
+ The first paragraph of the definition.
Paragraph two of the definition.