CODEWITHSUNDEEP
github
TaylorOtwell
TaylorOtwell

Reputation: 7337

Linking to other Wiki pages on GitHub?

GitHub wikis allow you to link to other pages in the wiki like so:

[[Wiki Page Name]]

However, I want to display different text than the wiki page name when making the link. Is there a way to do this? Am I linking to wiki pages all wrong?

Upvotes: 249

Views: 93979

Answers (5)

cbley
cbley

Reputation: 1755

GitHub by default uses Markdown syntax for the wikis so you can just use the page's path:

[Arbitrary Link Text](Wiki-Page-Name)

Check out Markdown and this blog post for more information about their wikis and the other markup syntaxes they support.

This solution has issues when you're on the home page because it creates relative URLs. Check out Sven's answer, below.

Upvotes: 104

bim
bim

Reputation: 829

  • The most common use [Link Text](WikiPageURL)
  • The second way: [[Link Text|WikiPageURL]]
  • The third way, if you do not want to repeat and need to use the hyperlink several times: [Link Text] and at the end of the page use once [Link Text]:WikiPageURL

Upvotes: 2

Tekkub
Tekkub

Reputation: 31695

Check the wiki editor's help. It tells you:

To create a reference link, use two sets of square brackets. [my internal link][internal-ref] will link to the internal reference internal-ref.

Upvotes: -8

Sven Jacobs
Sven Jacobs

Reputation: 6985

Using the Markdown link syntax

[Link Text](WikiPage)

seems to work in the edit preview but not on the actual wiki page. At least for me the generated link is WikiPage instead of wiki/WikiPage and I get the famous GitHub 404.

However the MediaWiki syntax

[[Link Text|WikiPage]]

works for me, even for Markdown wiki pages.

Upvotes: 342

Brett
Brett

Reputation: 1243

The internal-ref part is relative to your project. For wiki pages use:

[Page Name](wiki/Page-Name)

In the preview the link will be broken but when the page is saved it will work.

Upvotes: 41

Related Questions