Search code examples
githubmarkdownwiki

Make reference to a section of my wiki

I am working on a Wiki on GitHub and I'd like to use references to tell the user to go to an specific section of my wiki in case he/she wants to consult something.

For example

If you want to know more about this, go to **Section 2**


##Section 2
Some text

My intention is that if the user clicks on Section 2 he can immediately see what is on the Section 2. Like a link that leads to a section on the same wiki.

Solution

  • Each section anchor name is generated based on the section name, with hyphen between each word (lower case). For example, in https://github.com/Netflix/Hystrix/wiki#what-is-hystrix, you can hover over the chain icon beside the section name to take a peek at the anchor name (in this case, #what-is-hystrix):

    Link icon in section heading

    To make reference to it:

    [Go to section](#what-is-hystrix)