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
10 technical talks I’m excited about at GitHub Universe 2026
From verifying AI-written code to securing npm dependencies, these are the sessions I’m building my Universe agenda around.
Developer policy update: Transparency, state policy, and what’s ahead
Explore GitHub’s latest transparency data and learn more about policy updates affecting developers and open source.
Developers want more efficient software. Here’s what over 1,000 GitHub users told us they need.
New research from GitHub and Yale Program on Climate Change Communication finds strong demand for tools, measurement, and practical guidance that can help developers reduce wasted compute.