From aa0884f74571432686aec2caebb6d35097e25211 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Mon, 25 Mar 2024 14:38:10 +0100 Subject: [PATCH] Some exception that might not work (#31639) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- data/reusables/repositories/relative-links.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 88b2b7c2de..1d0010ee0d 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -8,4 +8,11 @@ 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 `../`. +Your link text should be on a single line. The example below will not work. + +```markdown +[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.