Correct ATX headings (add space after '#") #103
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
According to markdown specs ATX style '#' headings must be followed up a space; otherwise the #'s are escaped in many common renderers
philipbelesky
changed the title
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.
Hey, big fan of the Primer!
According to markdown specs ATX style '#' headings must be followed up a space; otherwise the #'s are escaped in many common renderers. For example, when viewed on Github many of the heading in this book are not displayed correctly.
I assume the gitbook renderer is lax about this, but it would be nice to fix for the occasions in which people are viewing the raw markdown either through a preview or when editing it in a text editor that has syntax highlighting. Currently the
.mdfiles are split between using a space correctly and omitting a space, so doing an all-at-once replace might also help to ensure consistency in future.