CODEWITHSUNDEEP
githubmarkdowngithub-flavored-markdown
rynop
rynop

Reputation: 53679

GitHub relative link in Markdown file

Is there a way to create a URL anchor, <a>, link from within a Markdown file, to another file within the same repository and branch (aka a link relative to the current branch)?

For example, in the master branch I have a README.md file, which I would like do something like:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib documentation
see documentation [here](myLib/README.md)

This would allow me to link from one .md to another within the same branch and not have to worry about which branch I'm in (avoid having to do an absolute URL that includes the github.com branch name).

Here is a working example of what I mean:

  1. GOTO http://github.com/rynop/testRel, link does not work.
  2. GOTO http://github.com/rynop/testRel/blob/master/README.md, link works.

This is expected because at this point the starting URL is in the branch. Now how do I get it to pick up the current branch in the README.md at the root of the repository?

Update: I opened an issue against GitHub for this feature request.

Upvotes: 1562

Views: 1258249

Answers (17)

Jesse
Jesse

Reputation: 996

The accepted answer quotes:

Also useful: When the link starts with a /, it is relative to the root of the repository (regardless of whether the markdown file is nested in subdirectories)

...which I needed, but this does not provide an example.

Here are examples based on the repo linked from the OP.

Using repository: github.com/rynop/testRel...

  • For directory: https://github.com/rynop/testRel/tree/master/myLib

    • Use: /myLib

  • For file: https://github.com/rynop/testRel/blob/master/myLib/README.md

    • Use: /myLib/README.md

Note, directory URLs are build on tree/master/, while file URLs are build on blob/master/.

That doesn't matter. GitHub will sort it out. (You might even be able to interchange tree with blob and URLs will redirect where they need to go.)

Just start with / at the end of tree/master/ or blob/master/ and your relative link should work.

Upvotes: 2

wooshuwu
wooshuwu

Reputation: 473

What I found to work for relative folders:

[link text](subfolder/subsubfolder/relevantfolder/)

where relevant folder is the folder you are trying to link to. The slash is needed after the final folder name. I tried including the project name and tree/main in the path and the other things suggested in previous answers, that lead to a nonexistent page error. The subfolder is a folder within the overall repo project folder.

Thus, file links would be in the form of:

[link text](subfolder/subsubfolder/relevantfolder/index.html)

If the desired file is not in any folder or subfolder the link is simply:

[link text](README.md)

for example the README file is not in any subfolders, so that could be the exact relative link you use for the README file.

Upvotes: 22

Eric
Eric

Reputation: 24974

Here is what I found for relative links in github's .md files:

  1. Relative links without ../ (aka. link to file in the same level, or in sub dir), seems always work.
  2. Relative links that contains ../ works only when you are already in a page whose url contains substring /blob/.
    • Otherwise need to use full url that contains /blob/, to link.
  3. Actually except top level /README.md, when view any other files, their url already contains /blob/.
    • Thus probably you can always use relative links that contains ../ in files, except /README.md.
    • But /README.md is in top level, thus it shouldn't need a relative link that contains ../.
    • So, you should never need a full path link (that contains github domain) to link to files in the same github repo.

Example (links among multiple language doc)

  • In /README.md, can use relative links without ../.

    [中文](doc/cn/README.md) |
[日本語](doc/jp/README.md)

  • In /doc/cn/README.md, since when we view it, the url already contains /blob/, thus could use relative links with ../.

    [English](../../README.md) |
[日本語](../jp/README.md)

(BTW, the example come from this git-merge-flow repo.)

Upvotes: 1

heySushil
heySushil

Reputation: 509

In .md file when you want to create a link to any related files which is related to same project folder or URL based links:

  1. Existing file link:

In .md file add showing name in [] box then open () in this box add / after that it will auto fetch all existing folders name form which you choose your folder then add '/' it will show inner file or 'folders`. This means it will auto fetch the paths and at the end, your URL is created.

Example:

[Enter Showing Name](/users/4000266/heysushil)

This line show like this: Enter Showing Name

  1. Add URLs on .md file

Follow the same process only change the () box path with URL like this:

 [HeySushil - YouTube](https://youtube.com/heysushil)

This looks like HeySushil - YouTube

Note: Remember no need to add force manually after adding / on () box it will auto fetch all existing folders and files.

Upvotes: 9

Werner Diwischek
Werner Diwischek

Reputation: 191

The behaviour in Github directory links in markdown files could create some headaches.

All files have an url are starting with blob,

blob/<branch>/<path>/<fileName>

whereas directories have an url starting with tree:

tree/<branch>/<path>

So no relative link to a directory should work. It points to an url that starts with a blob. Magically Github changes some relative path automatically to the tree path. Unfortunately not urls containing ".."

I investigate some time to examine the strange behaviour with Github directory links on https://github.com/fluentcodes/GitSamples-GIT/tree/github-readme-links.

Upvotes: 3

Mahozad
Mahozad

Reputation: 24692

You can also insert your links (relative or absolute) at the bottom to reduce clutter in text.
It can also be a good option for repetitive links.

This is [my linked text].

  [my linked text]: relative/path/in/repo/to/file.txt "Optional title for mouse hover"

This is my linked text.

Upvotes: 0

VonC
VonC

Reputation: 1328072

Update 30th, January 2013, 16 months later:

GitHub Blog Post Relative links in markup files:

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)
[a relative link](path%20with%20spaces/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.

Marcono1234 adds in the comments

Also useful: When the link starts with a /, it is relative to the root of the repository (regardless of whether the markdown file is nested in subdirectories)

Update December 20th, 2011:

The GitHub markup issue 84 is currently closed by technoweenie, with the comment:

We tried adding a <base> tag for this, but it causes problems with other relative links on the site.

October 12th, 2011:

If you look at the raw source of the README.md of Markdown itself(!), relative paths don't seem to be supported.
You will find references like:

[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13

As noted in InvisibleWolf's answer, if the target link is a directory and it has space, then you need to use %20 for each space.

Upvotes: 1805

Alan Viars
Alan Viars

Reputation: 3172

GitHub could make this a lot better with minimal work. Here is a work-around.

I think you want something more like

[Your Title](your-project-name/tree/master/your-subfolder)

or to point to the README itself

[README](your-project-name/blob/master/your-subfolder/README.md)

Upvotes: 42

Chamon Roy
Chamon Roy

Reputation: 801

Just follow the format below.

[TEXT TO SHOW](actual URL to navigate)

Upvotes: 2

WesternGun
WesternGun

Reputation: 12787

You can link to file, but not to folders, and keep in mind that, Github will add /blob/master/ before your relative link(and folders lacks that part so they cannot be linked, neither with HTML <a> tags or Markdown link).

So, if we have a file in myrepo/src/Test.java, it will have a url like:

https://github.com/WesternGun/myrepo/blob/master/src/Test.java

And to link it in the readme file, we can use:

[This is a link](src/Test.java)

or: <a href="src/Test.java">This is a link</a>.

(I guess, master represents the master branch and it differs when the file is in another branch.)

Upvotes: 16

InvisibleWolf
InvisibleWolf

Reputation: 1017

Just wanted to add this because none of the above solutions worked if target link is directory with spaces in it's name. If target link is a directory and it has space then even escaping space with \ doesn't render the link on Github. Only solution worked for me is using %20 for each space.

e.g.: if directory structure is this

Top_dir
|-----README.md
|-----Cur_dir1
      |----Dir A
           |----README.md
      |----Dir B
           |----README.md

To make link to Dir A in README.md present in Top_dir you can do this:

[Dir 1](Cur_dir1/Dir%20A)

Upvotes: 18

mathsyouth
mathsyouth

Reputation: 4188

For example, you have a repo like the following:

project/
    text.md
    subpro/
       subtext.md
       subsubpro/
           subsubtext.md
       subsubpro2/
           subsubtext2.md

The relative link to subtext.md in text.md might look like this: 

[this subtext](subpro/subtext.md)

The relative link to subsubtext.md in text.md might look like this: 

[this subsubtext](subpro/subsubpro/subsubtext.md)

The relative link to subtext.md in subsubtext.md might look like this: 

[this subtext](../subtext.md)

The relative link to subsubtext2.md in subsubtext.md might look like this: 

[this subsubtext2](../subsubpro2/subsubtext2.md)

The relative link to text.md in subsubtext.md might look like this: 

[this text](../../text.md)

Upvotes: 196

Alex
Alex

Reputation: 3431

This question is pretty old, but it still seems important, as it isn't easy to put relative references from readme.md to wiki pages on Github.

I played around a little bit and this relative link seems to work pretty well:

[Your wiki page](../../wiki/your-wiki-page)

The two ../ will remove /blob/master/ and use your base as a starting point. I haven't tried this on other repositories than Github, though (there may be compatibility issues).

Upvotes: 13

elomage
elomage

Reputation: 4474

If you want a relative link to your wiki page on GitHub, use this:

Read here: [Some other wiki page](path/to/some-other-wiki-page)

If you want a link to a file in the repository, let us say, to reference some header file, and the wiki page is at the root of the wiki, use this:

Read here: [myheader.h](../tree/master/path/to/myheader.h)

The rationale for the last is to skip the "/wiki" path with "../", and go to the master branch in the repository tree without specifying the repository name, that may change in the future.

Upvotes: 6

Antonio Carlos Ribeiro
Antonio Carlos Ribeiro

Reputation: 87779

I am not sure if I see this option here. You can just create a /folder in your repository and use it directly:

[a relative link](/folder/myrelativefile.md)

No blob or tree or repository name is needed, and it works like a charm.

Upvotes: 6

Gajus
Gajus

Reputation: 73918

As of January 31, 2013 Github markdown supports relative links to files.

[a relative link](markdown_file.md)

However, there are a few deficiencies that have been discussed in this comment thread.

As an alternative, you can use Gitdown to construct full URLs to the repository and even make them branch aware, e.g.

{"gitdown": "gitinfo", "name": "url"} // https://github.com/gajus/gitdown
{"gitdown": "gitinfo", "name": "branch"} // master

Gitdown is a GitHub markdown preprocessor. It streamlines common tasks associated with maintaining a documentation page for a GitHub repository, e.g. generating table of contents, including variables, generating URLs and getting information about the repository itself at the time of processing the input. Gitdown seamlessly integrates with your building scripts.

I am the author of the Gitdown library.

Upvotes: 33

Jon Chase
Jon Chase

Reputation: 563

You can use relative URLs from the root of your repo with <a href="">. Assuming your repo is named testRel, put the following in testRel/README.md:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib docs
see documentation:
    * <a href="testRel/myLib">myLib/</a>
    * <a href="testRel/myLib/README.md">myLib/README.md</a>

Upvotes: 11

Related Questions