{{ message }}
Tons of Markdown fixes, improvements, and cleanup#151
Open
nattheriddle1 wants to merge 13 commits into
Open
Conversation
Before, empty anchor tags with name attributes were placed before headings, so other anchor tags could target and automatically scroll to the heading when clicked. However, this functionality can and should be implemented by giving the headings ID attributes instead. This is more concise, easier to maintain, and a more proper use of HTML5.
Markdown syntax is more concise and should be preferred over inline HTML.
Many of the headings on the website were broken, as many of the headings lacked a space after the hashtags, which many Markdown renderers require.
Markdown syntax is more concise and should be preferred over inline HTML.
Markdown syntax is more concise and should be preferred over inline HTML.
Markdown syntax is more concise and should be preferred over inline HTML.
Markdown ignores more than 2 newlines in a row.
Standardized number of dots in ellipses and surrounding spacing.
Removed spaces, added colons, and capitalized where necessary.
Markdown headings should be followed by 1 blank line, especially before indented code blocks.
Markdown list delimiters need only be followed by one space.
Replaced repeated hyphens and asterisks with triple hyphens. Replaced triple hyphens after a heading with more traditional Markdown headings. Replaced triple tildes for code blocks with triple backticks.
Made ordered list delimiters sequential. Converted unordered list delimiters to asterisks. Made quotation list citation scheme consistent across languages.
Contributor
Contributor
|
Pull requests that touch 100+ files always scare me as a reviewer but this looks good at first glance. |
Author
Closed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
These changes massively improve the Markdown files, both for people browsing the live website and the GitHub repository.
For people browsing the live website, the changes fix the widespread problem of Markdown headings not rendering, as well as generally reducing awkward inconsistencies like extra spacing around punctuation, or too many/few dots in ellipses (...).
For people browsing or contributing to the GitHub repository, the changes also make the Markdown files more consistent with each other and with commonly accepted Markdown conventions, which makes it more straightforward for future contributors to analyze and edit them.
I've tried to explain my reasoning behind each commit in their descriptions.