markdown tips and tricks

Aliases
  • markdown tips and tricks
  • md tips and tricks
Image of Author
September 12, 2022 (last updated September 4, 2023)

Syntax

This is [a link to my website](https://gatlin.io)
This is [a reference-style link to my website][1]

[1]: https://gatlin.io
This is [a titled link](https://gatlin.io "gatlin.io"). 

A "titled" link is useful when converting markdown to html, as it translates to hover text. E.g., hovering over the titled link above would show the popup text "gatlin.io".

Footnotes

A footnoted[^1] sentence.[^2]

[^1]: Footnote one, inline
[^2]:
    Footnote two,
    which is
    multi-line

How footnotes get converted to html is dependent on your conversion tool of choice. (As best I can tell, footnotes are not covered in CommonMark or GFM specs, see markdown for more.) Processing tools will usually append a new section at the end of your content and hyperlink to it via linked superscripts.

Resources