search

rogerxu / git-tips

Tips for Git
Apache License 2.0
2 stars 3 forks source link

Relative links in README #16

Open rogerxu opened 8 years ago

rogerxu commented 8 years ago

How to add relative links and render in README.md?

rogerxu commented 8 years ago

Relative links in Repo

Repo link in Repo

Relative links in READMEs - User Documentation

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. You can use all relative link operands, such as ./ and ../.

Wiki link in Repo

TBD

rogerxu commented 8 years ago

Relative links in Wiki

Repo link in Wiki

TBD

Wiki link in Wiki

TBD

rogerxu commented 7 years ago

Relative links in Issue

Repo link in Issue

TBD

Wiki link in Issue

TBD

Issue link in Issue

TBD