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:
…you can use a relative link:
[a relative link](other_file.md)
and we’ll make sure it gets linked to
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!