GitHub relative link in Markdown file

by

Update 30th, January 2013, 16 months later:

GitHub Blog Post Relative links in markup files:

Starting today, GitHub supports relative links in markup files.
Now you can link directly between different documentation files, whether you view the documentation on GitHub itself, or locally, using a different markup renderer.

You want examples of link definitions and how they work? Here’s some Markdown for you.
Instead of an absolute link:

[a link](https://github.com/user/repo/blob/branch/other_file.md)

…you can use a relative link:

[a relative link](other_file.md)
[a relative link](path%20with%20spaces/other_file.md)

and we’ll make sure it gets linked to user/repo/blob/branch/other_file.md.

If you were using a workaround like [a workaround link](repo/blob/master/other_file.md), you’ll have to update your documentation to use the new syntax.

This also means your documentation can now easily stand on its own, without always pointing to GitHub.

Marcono1234 adds in the comments

Also useful: When the link starts with a /, it is relative to the root of the repository (regardless of whether the markdown file is nested in subdirectories)

Update December 20th, 2011:

The GitHub markup issue 84 is currently closed by technoweenie, with the comment:

We tried adding a <base> tag for this, but it causes problems with other relative links on the site.

October 12th, 2011:

If you look at the raw source of the README.md of Markdown itself(!), relative paths don’t seem to be supported.
You will find references like:

[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13

As noted in InvisibleWolf‘s answer, if the target link is a directory and it has space, then you need to use %20 for each space.

More Related Contents:

  1. How to add images to README.md on GitHub?
  2. How to add color to GitHub’s README.md file
  3. How to show math equations in general github’s markdown(not github’s blog)
  4. How do I center an image in the README.md file on GitHub?
  5. Is there a command line utility for rendering GitHub flavored Markdown?
  6. Latex rendering in README.md on Github
  7. Updates were rejected because the tip of your current branch is behind hint: its remote counterpart. Integrate the remote changes (e.g [duplicate]
  8. How to escape a pipe char in a code statement in a markdown table?
  9. Syncing with github
  10. Github “Updates were rejected because the remote contains work that you do not have locally.”
  11. How do I configure GitHub to use non-supported Jekyll site plugins?
  12. Delete fork dependency of a GitHub repository
  13. Delete a closed pull request from GitHub
  14. How do I clone a GitHub wiki?
  15. A Script to Simplify Creating a SO Table
  16. GitHub: invalid username or password
  17. Github Actions, how to share a calculated value between job steps?
  18. How do you change a repository description on GitHub?
  19. How does squashing, rebasing, reset –soft affect github contributions page?
  20. How do I create a folder in a GitHub repository?
  21. How to embed a video into GitHub README.md?
  22. Having a private branch of a public repo on GitHub?
  23. How can I wrap my markdown in an HTML div?
  24. Issues with pushing large files through Git
  25. How can I move a Git repository with all branches from Bitbucket to GitHub?
  26. Push to GitHub without a password using ssh-key
  27. Linking to other Wiki pages on GitHub?
  28. Download latest GitHub release
  29. How to fix bower ECMDERR
  30. Can I have my GitHub Pages index.html in a subfolder of the repository?

Leave a Comment