This repository was archived by the owner on Sep 30, 2020. It is now read-only.
Fix website formatting issue #781
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
The Markdown engine used for rendering the rust-lang website does not like headings which are not preceded by a linefeed, i.e. this code... ``` Something ## A heading ``` ...will be badly rendered as `Something ## A heading`. Note that this behaviour violates the CommonMark spec ( http://spec.commonmark.org/0.27/#atx-headings : "ATX headings need not be separated from surrounding content by blank lines, and they can interrupt paragraphs"). So if you know more than me about the rendering engine in use, you can ask them to fix their parser. But since putting blank lines before and after headings makes the markdown style more consistent/readable anyway, I've went for the alternate option of working around the parser bug :)
It's the default github stuff. kramdown?
agree 100%. Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The Markdown engine used for rendering the rust-lang website does not like headings which are not preceded by a linefeed, i.e. this code...
...will be badly rendered as
Something ## A heading.Note that this behaviour violates the CommonMark spec ( http://spec.commonmark.org/0.27/#atx-headings : "ATX headings need not be separated from surrounding content by blank lines, and they can interrupt paragraphs"). So if you know more than me about the rendering engine in use, you might want to ask them to fix their parser.
But since putting blank lines before and after headings makes the markdown coding more consistent/readable anyway, I've went for the alternate option of working around the parser bug and putting line feeds everywhere :)