From aea0ae7e8f0c32c8e59f6533b3090d1d10bb228a Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Sat, 5 Feb 2022 09:59:34 +0100 Subject: [PATCH] chore(markdown): Use anchors for lengthy links. See #1808 --- markdown/dev/guides/markdown/frequent-mistakes/en.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/markdown/dev/guides/markdown/frequent-mistakes/en.md b/markdown/dev/guides/markdown/frequent-mistakes/en.md index 46431879c31..6cf408c4db4 100644 --- a/markdown/dev/guides/markdown/frequent-mistakes/en.md +++ b/markdown/dev/guides/markdown/frequent-mistakes/en.md @@ -7,7 +7,9 @@ Some things to keep in mind when working in Markdown are: ## Use remark-jargon for glossary terms -There is no need to add a *glossary* section to documentation. We use a plugin called [remark-jargon](https://github.com/freesewing/freesewing/blob/develop/packages/remark-jargon/README.md) to explain terms. Information can be found at the link. +There is no need to add a *glossary* section to documentation. We use a plugin called [remark-jargon][rj] to explain terms. Information can be found at the link. + +[rj]: https://github.com/freesewing/freesewing/blob/develop/packages/remark-jargon/README.md ## Let lists be lists @@ -21,7 +23,9 @@ If you get lost or have a question about how to do something, feel free to come ## Create meaningful links -When adding links please do not link them using a structure like: Link [here](https://www.youtube.com/watch?v=dQw4w9WgXcQ). Instead put the link under the relevant term. See first list item for an example. +When adding links please do not link them using a structure like: Link [here][yt]. Instead put the link under the relevant term. See first list item for an example. + +[yt]: https://www.youtube.com/watch?v=dQw4w9WgXcQ ## Make sure your links lead where they think you do