From c418b3bd6c0274514a870fb5249bf90efc14033b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Wed, 14 Feb 2024 10:15:20 +0100 Subject: [PATCH 1/6] Some exception that might not work Well, I've spent the best part of the morning trying to find out why [this](https://github.com/orgs/community/discussions/108272) happened; I [got to raise this issue](https://github.com/benbalter/jekyll-relative-links/issues/93) but at any rate it's easier to fix the documentation than fixing the issue. The issue should be right around this line https://github.com/benbalter/jekyll-relative-links/blob/9f05f8524cd974fc151d0d960ae3ad2e4935d3c6/lib/jekyll-relative-links/generator.rb#L52, and I might try to fix it some time in the future, but meanwhile I (or someone else) gets around to do it, gets fixed, and deployed downstream to GitHub pages (which is where I use), this little fix can help lost souls like myself save a bit of time, right? Lots of love to you and all the world in this Valentine day! --- data/reusables/repositories/relative-links.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 88b2b7c2de1c..77e6739d3e76 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -8,4 +8,13 @@ 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 not that using links in this way: + +```markdown +[this +is a perfectly good relative link](link/relative) +``` + +might now work. Please keep the text link in a single page. + 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. From 0e5b0390ace69a4c3e44c66923803b37e24b54e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Wed, 14 Feb 2024 10:18:53 +0100 Subject: [PATCH 2/6] Couple of typos :recycle: --- data/reusables/repositories/relative-links.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 77e6739d3e76..5aae9551b68b 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -8,13 +8,13 @@ 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 not that using links in this way: +Please note that using links in this way: ```markdown [this is a perfectly good relative link](link/relative) ``` -might now work. Please keep the text link in a single page. +might now work. Please keep the text link in a single line. 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. From ab6c9f1c65524dc4061eea760ef3cdee24123f7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Wed, 14 Feb 2024 10:34:11 +0100 Subject: [PATCH 3/6] Improve text --- data/reusables/repositories/relative-links.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 5aae9551b68b..53d8efae45a6 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -12,9 +12,9 @@ Please note that using links in this way: ```markdown [this -is a perfectly good relative link](link/relative) +is a perfectly good relative link](link/relative.md) ``` -might now work. Please keep the text link in a single line. +might prevent the link to be converted to `relative/html`. Please keep the text link in a single line. 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. From ea08ecfdb3b4279547446df03a3aabbba06edcaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Wed, 14 Feb 2024 10:35:12 +0100 Subject: [PATCH 4/6] Even better :recycle: --- data/reusables/repositories/relative-links.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 53d8efae45a6..62bc0b065e8c 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -12,9 +12,9 @@ Please note that using links in this way: ```markdown [this -is a perfectly good relative link](link/relative.md) +is a perfectly good relative link](folder/relative.md) ``` -might prevent the link to be converted to `relative/html`. Please keep the text link in a single line. +might prevent the link to be converted to `folder/relative.html`. Please keep the text link in a single line. 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. From 5f4150436d23e8b563eb3829371d5339cf935c03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Juli=C3=A1n=20Merelo=20Guerv=C3=B3s?= Date: Fri, 22 Mar 2024 19:53:49 +0100 Subject: [PATCH 5/6] Update data/reusables/repositories/relative-links.md It's absolutely perfect. Thanks! Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- data/reusables/repositories/relative-links.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 62bc0b065e8c..6a4b3df3ef5b 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -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. From f4f59dcb6948760106ae58b19ff021ea946587ac Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Mon, 25 Mar 2024 11:12:27 +0100 Subject: [PATCH 6/6] Update relative-links.md --- data/reusables/repositories/relative-links.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/data/reusables/repositories/relative-links.md b/data/reusables/repositories/relative-links.md index 6a4b3df3ef5b..1d0010ee0da2 100644 --- a/data/reusables/repositories/relative-links.md +++ b/data/reusables/repositories/relative-links.md @@ -13,4 +13,6 @@ 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.