Don't render single newlines as line-breaks #40
Merged
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.
When rendering markdown, single newlines are typically ignored and only double newlines are rendered as a new paragraph.
This allows for each sentence to be on a new line without introducing unnecessary line breaks in the rendered document. Keeping each sentence on a new line makes reviews easier and plays well with Git which tracks changes on a line-by-line basis. It also eases collaboration of documents in GitHub's PR process through the "suggestion" feature.
Here are two screenshot comparing the two renderings.
breaks: false
(the default)breaks: true
As we can see, the rendering is identical. Changing this setting will allow us to use "one sentence per line" in future posts. It is however not mandatory in case some authors don't want to use it.
I am not sure it is worth to convert existing posts.