Skip to content

Commit

Permalink
Update data/reusables/repositories/relative-links.md
Browse files Browse the repository at this point in the history
It's absolutely perfect. Thanks!

Co-authored-by: Sophie <[email protected]>
  • Loading branch information
JJ and sophietheking authored Mar 22, 2024
1 parent ed44eb0 commit 5f41504
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions data/reusables/repositories/relative-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,9 @@ A relative link is a link that is relative to the current file. For example, if

{% 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 `../`.

Please note that using links in this way:
Your link text should be on a single line. The example below will not work.

```markdown
[this
is a perfectly good relative link](folder/relative.md)
```

might prevent the link to be converted to `folder/relative.html`. Please keep the text link in a single line.

[Contribution
guidelines for this project](docs/CONTRIBUTING.md)
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 comments on commit 5f41504

Please sign in to comment.