How to link to part of the same document in Markdown?

markdown multimarkdown
recipriversexclusion picture recipriversexclusion · May 12, 2010 · Viewed 325.2k times · Source

I am writing a large Markdown document and would like to place a table of contents of sorts at the beginning that will provide links to various locations in the document. How can I do this?

I tried using:

[a link](# MyTitle)

where MyTitle is a title within the document but this didn't work.

Answer

uberllama picture uberllama · May 7, 2013

Github automatically parses anchor tags out of your headers. So you can do the following:

[Custom foo description](#foo)

# Foo

In the above case, the Foo header has generated an anchor tag with the name foo

Note: just one # for all heading sizes, no space between # and anchor name, anchor tag names must be lowercase, and delimited by dashes if multi-word.

[click on this link](#my-multi-word-header)

### My Multi Word Header

Update

Works out of the box with pandoc too.

Related questions

How to link to a named anchor in Multimarkdown?

I have come across a number of mentions of MultiMarkdown's support for internal links / named anchors but I am unable to find a single example of how to actually do it. So, what is the syntax for denoting the named …

Read More
Create a table without a header in Markdown

Is it possible to create a table without a header in Markdown? The HTML would look like this: <table> <tr> <td>Key 1</td> <td>Value 1</td> </tr&…

Read More
How to add footnotes to GitHub-flavoured Markdown?

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 …

Read More