Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Commit

Permalink
add note on using markdown reference links
Browse files Browse the repository at this point in the history
  • Loading branch information
fricklerhandwerk committed May 19, 2022
1 parent ca0bdc5 commit 81c9ba5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,8 @@ The rule is unambiguous and does not require tooling support to be applied easil

[Here is a discussion of different line wrapping styles.][markdown-wrapping-styles]

Use [reference links][reference-link] to keep the plain text readable.
Collect links at the end of each section, which are delimited by headings.

[markdown-wrapping-styles]: https://web.archive.org/web/20220519121408/https://mtsknn.fi/blog/4-1-wrapping-styles-for-markdown-prose-and-code-comments/
[reference-link]: https://github.github.com/gfm/#reference-link

0 comments on commit 81c9ba5

Please sign in to comment.