How do I create some kind of table of content in GitHub wiki?

github wiki
Evan picture Evan · Aug 15, 2013 · Viewed 87.6k times · Source

If you look here: http://en.wikipedia.org/wiki/Stack_Overflow

You'll notice there's a little "Content" section, if you click on one of the links, it will send you to a specific section on the page.

How do I do this in GitHub wiki? With Markdown or whatever they use?

Answer

RyPeck picture RyPeck · Aug 15, 2013

It is nicely demonstrated in the Table of Contents of the Markdown Cheatsheet.

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

If you hover over a Header in a GitHub Markdown file, you'll see a little link simple to the left of it, you can also use that link. The format for that link is <project URL#<header name>. The <header name> must be all lower case.

Related questions

Resize image in the wiki of GitHub using Markdown

I'm writing a wiki page on GitHub, and I'm using Markdown. My problem is that I'm putting a large image (this image is in its own repository) and I need resize it. I have tried different solutions, but they do …

Read More
How to style a JSON block in Github Wiki?

Is there a way to nicely format/style JSON code in Github Wiki (i.e Markdown preferred)? Something like this with few colors (or bold) and correct indentation: http://www.freeformatter.com/json-formatter.html#ad-output

Read More
Embedding images inside a GitHub wiki (gollum) repository?

The Github wikis are backed by a separate git repository then the main project repository. This post by the Github team makes it sound like you should be able to link to images stored in the wiki repository inside the …

Read More