The Dead Simple Markdown Guide to Links

Links

To create a link, enclose the link text in brackets (e.g., [Duck Duck Go]) and then follow it immediately with the URL in parentheses (e.g., (//duckduckgo.com)).

My favorite search engine is Duck Duck Go.

The rendered output looks like this:

My favorite search engine is .

Adding Titles

You can optionally add a title for a link. This will appear as a tooltip when the user hovers over the link. To add a title, enclose it in quotation marks after the URL.

My favorite search engine is [Duck Duck Go](//duckduckgo.com "The best search engine for privacy").

The rendered output looks like this:

My favorite search engine is .

URLs and Email Addresses

To quickly turn a URL or email address into a link, enclose it in angle brackets.

<//www.markdownguide.org>
<[email protected]>

The rendered output looks like this:

Formatting Links

To  links, add asterisks before and after the brackets and parentheses. To denote links as , add backticks in the brackets.

I love supporting the . This is the . See the section on code.

The rendered output looks like this:

I love supporting the .
This is the**.
See the section oncode.

Reference-style Links

Reference-style links are a special kind of link that make URLs easier to display and read in Markdown. Reference-style links are constructed in two parts: the part you keep inline with your text and the part you store somewhere else in the file to keep the text easy to read.

Formatting the First Part of the Link

The first part of a reference-style link is formatted with two sets of brackets. The first set of brackets surrounds the text that should appear linked. The second set of brackets displays a label used to point to the link you’re storing elsewhere in your document.

Although not required, you can include a space between the first and second set of brackets. The label in the second set of brackets is not case sensitive and can include letters, numbers, spaces, or punctuation.

This means the following example formats are roughly equivalent for the first part of the link:

• [hobbit-hole][1]
• [hobbit-hole] [1]

Formatting the Second Part of the Link

The second part of a reference-style link is formatted with the following attributes:

1. The label, in brackets, followed immediately by a colon and at least one space (e.g., [label]: ).

   
   

2. The URL for the link, which you can optionally enclose in angle brackets.

   
   

3. The optional title for the link, which you can enclose in double quotes, single quotes, or parentheses.

This means the following example formats are all roughly equivalent for the second part of the link:

• [1]: //en.wikipedia.org/wiki/Hobbit#Lifestyle

  
  

• [1]: //en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"

  
  

• [1]: //en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'

  
  

• [1]: //en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)

  
  

• [1]: <//en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"

  
  

• [1]: <//en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'

  
  

• [1]: <//en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

You can place this second part of the link anywhere in your Markdown document. Some people place them immediately after the paragraph in which they appear while other people place them at the end of the document (like endnotes or footnotes).

An Example Putting the Parts Together

Say you add a URL as a  to a paragraph and it looks like this in Markdown:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole](//en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"), and that means comfort.

Though it may point to interesting additional information, the URL as displayed really doesn’t add much to the existing raw text other than making it harder to read. To fix that, you could format the URL like this instead:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole][1], and that means comfort.

[1]: <//en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"

In both instances above, the rendered output would be identical:

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a , and that means comfort.

and the HTML for the link would be:

<a href="//en.wikipedia.org/wiki/Hobbit#Lifestyle" title="Hobbit lifestyles">hobbit-hole</a>

Link Best Practices

Markdown applications don’t agree on how to handle spaces in the middle of a URL. For compatibility, try to URL encode any spaces with %20. Alternatively, if your Markdown application , you could use the a HTML tag.

✅  Do this	❌  Don't do this
[link](//www.example.com/my%20great%20page) <a href="//www.example.com/my great page">link</a>	[link](//www.example.com/my great page)

Parentheses in the middle of a URL can also be problematic. For compatibility, try to URL encode the opening parenthesis (() with %28 and the closing parenthesis ()) with %29. Alternatively, if your Markdown application , you could use the a HTML tag.

✅  Do this	❌  Don't do this
[a novel](//en.wikipedia.org/wiki/The_Milagro_Beanfield_War_%28novel%29) <a href="//en.wikipedia.org/wiki/The_Milagro_Beanfield_War_(novel)">a novel</a>	[a novel](//en.wikipedia.org/wiki/The_Milagro_Beanfield_War_(novel))