summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-12-19 07:30:36 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-12-19 07:30:36 +0000
commit3a6296acae34ddb2ea7678ee6d8c727aab4eb087 (patch)
treea1e35b6d586dbf72ac0314241f1bae1881d51162 /README
parenta8bbd950e526abb69262fb7186ced583885c6ac8 (diff)
Changed footnote syntax to conform to the de facto standard
for markdown footnotes. References are now like this[^1] rather than like this^(1). There are corresponding changes in the footnotes themselves. See the updated README for more details. git-svn-id: https://pandoc.googlecode.com/svn/trunk@230 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 15 insertions, 13 deletions
diff --git a/README b/README
index f63d0477a..c59f8880a 100644
--- a/README
+++ b/README
@@ -341,23 +341,25 @@ appear as `[link]` if there's no reference for `link`. If you want
Pandoc's markdown allows footnotes, using the following syntax:
- here is a footnote reference,^(1) and another.^(longnote)
+ Here is a footnote reference,[^1] and another.[^longnote]
- ^(1) Here is the footnote. It can go anywhere in the document,
+ [^1]: Here is the footnote. It can go anywhere in the document,
except in embedded contexts like block quotes or lists.
- ^(longnote) Here's the other note. This one contains multiple
+ [^longnote]: Here's the other note. This one contains multiple
blocks.
- ^
- ^ Caret characters are used to indicate that the blocks all belong
- to a single footnote (as with block quotes).
- ^
- ^ If you want, you can use a caret at the beginning of every line,
- ^ as with blockquotes, but all that you need is a caret at the
- ^ beginning of the first line of the block and any preceding
- ^ blank lines.
-
-Footnote references may not contain spaces, tabs, or newlines.
+
+ Subsequent blocks are indented to show that they belong to
+ the previous footnote.
+
+ { some.code }
+
+ The whole block can be indented, or just the first line.
+ In this way, multi-block footnotes work just like multi-block
+ list items in markdown.
+
+The identifiers in footnote references may not contain spaces, tabs,
+or newlines.
## Embedded HTML