Skip to content

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.…

Author

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!

Explore more from GitHub

Product

Product

Updates on GitHub products and features, hot off the press.
The ReadME Project

The ReadME Project

Stories and voices from the developer community.
GitHub Copilot

GitHub Copilot

Don't fly solo. Try 30 days for free.
Work at GitHub!

Work at GitHub!

Check out our current job openings.