readme: replace headings with alerts #189
Merged
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
Used GitHub Flavored Markdown's alerts feature for more semantic markup than using headings. For all the reasons semantic markup is usually good, but on GitHub in particular they add underlines and links and stuff to headings which aren't needed here. Arguably makes the text stand out less than using headings, but when when everything is a heading, it's hard for anything to stand out. Used bold and different kinds of alerts to indicate relative importance. Otherwise, tried to keep refactoring to a minimum.
|
Yess, I agree. This is in fact what bothers me the most every time I return to this github repo to update my ProtonGE. There's too many giant headings in the first few lines. |
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.
Used GitHub Flavored Markdown's alerts feature for more semantic markup than using headings. For all the reasons semantic markup is usually good, but on GitHub in particular they add underlines and links and stuff to headings which aren't needed here.
Arguably makes the text stand out less than using headings, but when when everything is a heading, it's hard for anything to stand out.
Used bold and different kinds of alerts to indicate relative importance.
Otherwise, tried to keep refactoring to a minimum.