Relative links in markup files
We show rendered markup in several places on GitHub, most notably including a project’s main README on the Repository page itself. Starting today, GitHub supports relative links in markup files.…
We show rendered markup in several places on GitHub, most notably including a
project’s main README on the Repository page itself.
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)
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.
If you want more information, we have a help article for you. Happy documenting!
Written by
Related posts
Developer policy update: Intermediary liability, copyright, and transparency
We’re sharing recent policy updates that developers should know about, updating our Transparency Center with the full year of 2025 data, and looking to what’s ahead.
GitHub availability report: March 2026
In March, we experienced four incidents that resulted in degraded performance across GitHub services.
GitHub Universe is back: We want you to take the stage
Get inspired by five of the most memorable, magical, and quirky Universe sessions to date.