How to add footnotes to GitHub-flavoured Markdown

Question

I am just trying to add footnotes in my GitHub Gist  but it doesn t work   Some long sentence    footnote     footnote   Test   Link  https   google com     I am following this guide and I don t think I m doing anything wrong  Can someone point out my mistake

User · Answer

Although the question is about GitHub flavored Markdown, I think it's worth mentioning that as of 2013, GitHub supports AsciiDoc which has this feature builtin. You only need to rename your file with a .adoc extension and use:

A statement.footnote:[Clarification about this statement.]

A bold statement!footnote:disclaimer[Opinions are my own.]

Another bold statement.footnote:disclaimer[]

Documentation along with the final result is here.

User · Answer

Expanding on the previous answers even further  you can add an id attribute to your footnote s link    Bla bla  lt sup id  a1  gt  1   f1  lt  sup gt    Then from within the footnote  link back to it    lt b id  f1  gt 1 lt  b gt  Footnote content here       a1    This will add a little   at the end of your footnote s content  which takes your readers back to the line containing the footnote s link

User · Answer

Here s a variation of Eli Holmes  answer that worked for me without using latex   Text lt span id  a1  gt       1  lt  span gt    lt span id  1  gt    lt  span gt  Footnote      a1  lt br gt    Example

User · Answer

I wasn t able to get Surya s and Matteo s solutions to work   For example     f1   was just displayed as text  and didn t become a link   However  their solutions led me to slightly different solution    I also formatted the footnote and the link back to the original superscript a bit differently    In the body of the text   Yadda yadda lt a href   note1  id  note1ref  gt  lt sup gt 1 lt  sup gt  lt  a gt    At the end of the document    lt a id  note1  href   note1ref  gt  lt sup gt 1 lt  sup gt  lt  a gt Here is the footnote text    Clicking on the superscript in the footnote returns to the superscript in the original text

User · Answer

GitHub Flavored Markdown doesn t support footnotes  but you can manually fake it   with Unicode characters or superscript tags  e g   lt sup gt 1 lt  sup gt      Of course this isn t ideal  as you are now responsible for maintaining the numbering of your footnotes  It works reasonably well if you only have one or two  though

User · Answer

This works for me   blablabla   lt sup gt 1 lt  sup gt    1  blablabla  footnotes  reference to blablabla  lt a class  anchor  id  1  gt  lt  a gt

User · Answer

For short notes  providing an anchor element with a title attribute creates a  tooltip     lt a title  Note text goes here   gt  lt sup gt n lt  sup gt  lt  a gt    Otherwise  for more involved notes  it looks like your best bet is maintaining named links manually

User · Answer

Although I am not aware if it s officially documented anywhere  you can do footer notes in Github     Mark the place where you want to insert footer link with a number enclosed in square brackets  I E   1  On the bottom of the post  make a reference of the numbered marker and followed by a colon and the link  I E   1   http   www example com link1   And once you preview it  it will be rendered as numbered links in the body of the post

User · Answer

I used a variant of Mateo s solution   I m using this in Rmd files written in github flavored markdown  gfm  for a Jekyll powered website but the same Rmd files are being used to produce pdfs in various contexts   The Rmd files are math heavy and the math is displayed with MathJax on the website   So I needed a solution that works with gfm that is processed via Jekyll  works with pandoc- pdflatex  and is compatible with MathJax    snippet from Rmd file  which is gfm   Here is a paragraph with an footnote  lt span id  a1  gt   1    f1  lt  span gt    Footnotes            1   lt span id  f1  gt  lt  span gt  This is a footnote     hookleftarrow    a1      hookleftarrow  is latex  which works for me since I always have MathJax enabled   I use that to make sure it shows up correctly in my pdfs   I put my  footnotes in square brackets because superscript is confusing if I am putting a footnote on some inline math   Here it is in action  https   eeholmes github io posts 2016-5-18-FI-recursion-1   These notes can be put anywhere in the Rmd   I am putting in a list at the end so they are technically endnotes

User · Answer

Expanding a little bit on the previous answer  you can make the footnote links clickable here as well  First define the footnote at the bottom like this   lt a name  myfootnote1  gt 1 lt  a gt   Footnote content goes here   Then reference it at some other place in the document like this   lt sup gt  1   myfootnote1  lt  sup gt

[markdown] How to add footnotes to GitHub-flavoured Markdown?

Examples related to markdown

Examples related to github-flavored-markdown

Examples related to multimarkdown