Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

headings not rendering anymore #1013

Closed
davidmoten opened this issue Mar 16, 2017 · 5 comments
Closed

headings not rendering anymore #1013

davidmoten opened this issue Mar 16, 2017 · 5 comments

Comments

@davidmoten
Copy link

In the last couple of days github markdown rendering has stopped rendering headings without delimiting spaces:

This used to render fine:

##Header

but now has to be:

## Header

Was this a deliberate move? You'd have to consider it a major breaking change!

@shawnajean
Copy link
Member

Hi David! This is related to our move to CommonMark for markdown rendering:

https://github.com/blog/2333-a-formal-spec-for-github-flavored-markdown

CommonMark requires that there be a space between the # characters and the title. We do not consider this a bug, so I'm going to close this out. Please reach out to our support team if you need more help!

@davidmoten
Copy link
Author

davidmoten commented Mar 16, 2017 via email

josephfrazier added a commit to josephfrazier/Brain that referenced this issue Mar 29, 2017
GitHub recently updated their Markdown renderer to require a space
between the `#` characters and the title of a header. See here for
details: github/markup#1013

This change was made by running:

    sed --in-place 's/^\(##*\)\([^# ]\)/\1 \2/' README.md
josephfrazier added a commit to josephfrazier/BrainGrapher that referenced this issue Mar 29, 2017
GitHub recently updated their Markdown renderer to require a space
between the `#` characters and the title of a header. See here for
details: github/markup#1013

This change was made by running:

    sed --in-place 's/^\(##*\)\([^# ]\)/\1 \2/' README.markdown
josephfrazier added a commit to josephfrazier/node-json-align that referenced this issue Mar 31, 2017
GitHub recently updated their Markdown renderer to require a space
between the `#` characters and the title of a header. See here for
details: github/markup#1013

This change was made by running:

    sed --in-place 's/^\(##*\)\([^# ]\)/\1 \2/' README.md
arminbw added a commit to arminbw/wiretouch that referenced this issue Apr 6, 2017
arminbw added a commit to arminbw/GermanDev that referenced this issue Apr 6, 2017
arminbw added a commit to arminbw/tangible-gmaps-polymer that referenced this issue Apr 6, 2017
benrichards86 added a commit to benrichards86/Verify that referenced this issue Apr 19, 2017
Just doing this to create a new push to try and get the front page Readme to render properly again. According to github/markup#1013 this should fix the rendering.
benrichards86 added a commit to benrichards86/Verify that referenced this issue Apr 19, 2017
Just doing this to create a new push to try and get the front page Readme to render properly again. According to github/markup#1013 this should fix the rendering.
doppelganger9 added a commit to doppelganger9/cordova-paramedic that referenced this issue Jul 18, 2017
2016rshah added a commit to 2016rshah/MobileKombatNode that referenced this issue Oct 26, 2017
2016rshah added a commit to 2016rshah/Andringa that referenced this issue Oct 26, 2017
2016rshah added a commit to bhavingpt/alexa-meditate that referenced this issue Oct 26, 2017
As per github/markup#1013 a space between the hashtag and text is *required* so I just put it in real quick.
ManuelVargas1251 pushed a commit to ManuelVargas1251/brackets-indentator that referenced this issue Nov 26, 2017
a github update made it so you need to add a space in between your pound sign and the text in order for markdown to parse correctly. more info here: github/markup#1013
caseywatts added a commit to caseywatts/sn-stats-calendar that referenced this issue Feb 23, 2018
@jaan
Copy link

jaan commented Jul 2, 2018

Found this issue on most of my readme pages. I wish github had proactively conveyed this to users about their broken pages and a need for fix.

@devios1
Copy link

devios1 commented Aug 27, 2018

This completely defeats the purpose of Markdown. What possible reason could there be for imposing this absurd restriction?

cribbles pushed a commit to cribbles/marked-ast that referenced this issue Aug 28, 2018
Requires a space between the hash and the heading markup. This
conforms to the CommonMark spec and is necessary for Github
compatibility.

See:

- github/markup#1013 (comment)
- https://blog.github.com/2017-03-14-a-formal-spec-for-github-flavored-markdown/
@lee-dohm
Copy link
Contributor

As was stated in this other issue, the markup gem doesn't control GitHub's Markdown rendering. Since this is off-topic for this repo, I'm going to lock this issue.

If you have questions about GitHub's Markdown rendering, please reach out to the support team.

@github github locked as off-topic and limited conversation to collaborators Aug 28, 2018
DannyBrassil referenced this issue in DannyBrassil/SQAfinalAssignment May 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants