VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Use anchors for lengthy links. See #1808

Browse source
This commit is contained in:
Joost De Cock 2022-02-05 09:59:34 +01:00
parent 50367237f1
commit aea0ae7e8f
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
markdown/dev/guides/markdown/frequent-mistakes/en.md
View file

@ -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