all repos — grayfriday @ ceb8293c340b3ea2025635db9a0facd98919c495

blackfriday fork with a few changes

Merge pull request #212 from nitoyon/readme

README: Add 'Definition lists' and 'Footnotes'
Vytautas Ĺ altenis vytas@rtfb.lt
Fri, 30 Oct 2015 20:37:43 +0200
commit

ceb8293c340b3ea2025635db9a0facd98919c495

parent

d4ee3ea08bf2f1471dbf7846090d9dd931609968

1 files changed, 19 insertions(+), 0 deletions(-)

jump to
M README.mdREADME.md

@@ -169,6 +169,25 @@

You can use 3 or more backticks to mark the beginning of the block, and the same number to mark the end of the block. +* **Definition lists**. A simple definition list is made of a single-line + term followed by a colon and the definition for that term. + + Cat + : Fluffy animal everyone likes + + Internet + : Vector of transmission for pictures of cats + + Terms must be separated from the previous definition by a blank line. + +* **Footnotes**. A marker in the text that will become a superscript number; + a footnote definition that will be placed in a list of footnotes at the + end of the document. A footnote looks like this: + + This is a footnote.[^1] + + [^1]: the footnote text. + * **Autolinking**. Blackfriday can find URLs that have not been explicitly marked as links and turn them into links.