Use Markdown reference-style links in documents. [ci skip] #696
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use Markdown reference-style links due to a better readability. See <https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links> for details.
|
I was also inspired from Sway window manager's README.md using the reference-style links. |
|
Yes, we should have been consistently using one of them. Thank you! |
|
You are welcome! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I find the Markdown's reference-style links are helpful for a better readability when seeing the text file directly by an editor, or when referring to one link from multiple parts. And I see the reference-style links are used in some parts, but not in some other parts. So, I used the reference-style links for all the parts in
README.mdandCONTRIBUTING.md.In the
README.md, the references are written in the end of the each session. In theCONTRIBUTING.md, the references are written in the end of the file. So, I followed the existing style for each file.I also checked all the links availability as a result, I changed the link of the
[DeveloperHowTo]and removed the unused[History.md].My idea of the references is the link item names in the reference area at the end of the file should describe what it is without ambiguity. For example, not
[Security]but[Ruby Security], and not[INSTALL]but[OpenSSL INSTALL].You can check the modified documents.
Use Markdown reference-style links due to a better readability. See https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links for details.