Skip to content

Commit b2804a3

Browse files
authored
Merge pull request #49841 from github/repo-sync
Repo sync
2 parents aa8dfd9 + aa0884f commit b2804a3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

data/reusables/repositories/relative-links.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,11 @@ A relative link is a link that is relative to the current file. For example, if
88

99
{% data variables.product.product_name %} 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. The path of the link will be relative to the current file. Links starting with `/` will be relative to the repository root. You can use all relative link operands, such as `./` and `../`.
1010

11+
Your link text should be on a single line. The example below will not work.
12+
13+
```markdown
14+
[Contribution
15+
guidelines for this project](docs/CONTRIBUTING.md)
16+
```
17+
1118
Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.

0 commit comments

Comments
 (0)