docs(npm-scripts): highlight scripts in list #271
Closed
Conversation
This file contains hidden or 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
|
Hi! Thank you very much for your PR. This has been addressed already in our new docs website. Please don't hesitate to contribute if you notice anything you can help with! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What / Why
Reading the docs I noticed that I have problems to mentally absorb the content because the mentioned scripts are not highlighted an so visually blend in to the surrounding text. This is not only a rendering issue because there is no syntax in the markdown to highlight this "sub-headers". I choose to use "bold" here other options would be "italic" or headings. I choose to use "bold".
This might be a useful change, especially for people with a reading-comprehension disability.
References
The "problematic" change was introduced with 3ef3ff0