Repository readme

You can add relative links into the repository README.md file using a special syntax.

Link to a file in the same directory as the README.md

For example: to link to a file called CHANGE_LOG.md, add a link in the following format:

[CHANGE_LOG](?path=CHANGE_LOG.md)

This links to .../tree/<branch name>?path=CHANGE_LOG.md and opens the file in the repository browser.

Link to a file in a sub-folder

For example: to link to a file called chuck.rb add the link in the following format:

[chuck.rb](?path=lib/chuck.rb)

This links to .../tree/<branch name>?path=lib/chuck.rb and opens the file in the repository browser.

Link to a raw file

For example: to link to a raw file called CHANGE_LOG.md, enter the link in the following format:

This links to [CHANGE_LOG](raw-file:CHANGE_LOG.md) and opens or downloads it directly.

Render an image

For example: to render an image called MyLogo.png in the readme file, add the link in the following format:


This links to <path/to>/MyLogo.png and renders the image in the readme file.