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

Raw HTML headers not rendering as before #1022

Closed
Snaipe opened this Issue Mar 20, 2017 · 8 comments

Comments

Projects
None yet
5 participants
@Snaipe

Snaipe commented Mar 20, 2017

See the 2 first lines: https://raw.githubusercontent.com/Snaipe/Criterion/bleeding/README.md

Very recently, this rendered properly as a header with only an image.

Now, it breaks, and renders the ========= verbatim below the image.

@danielpclark

This comment has been minimized.

danielpclark commented Mar 20, 2017

I can confirm this. I've lost all former headers down to hashtags on a few of my projects; and some clustered badges/headers have stopped rendering.

https://github.com/danielpclark/state_inspector/blob/dab18e0930d7b4f1cf40ae48ccdd4d30a24b603d/README.md

#Before

before

#Current

current


It appears that README headers now require a space before the text and in some cases blank lines around it.

@xgdgsc

This comment has been minimized.

xgdgsc commented Mar 21, 2017

Obviously Many projects are suffering this, especially those in the https://github.com/bayandin/awesome-awesomeness .

@kivikakk

This comment has been minimized.

Member

kivikakk commented Mar 22, 2017

These are happening due to our change to CommonMark. An empty line is required between HTML and Markdown. To fix it, try just wrapping the <img> tag in <h1> or similar!

Since this issue has to do with Markdown rendering, not markup, please reach out to the support team with further questions.

@kivikakk kivikakk closed this Mar 22, 2017

@atorstling

This comment has been minimized.

atorstling commented Apr 10, 2017

I think you should roll out a site notification or a mail explaining this change to all users, because a lot of repos basically have their welcome page uglified.

@kivikakk

This comment has been minimized.

Member

kivikakk commented Apr 10, 2017

There's a blog post (linked in my comment immediately above), and an engineering blog post. While many repositories are affected, a great many more were not, so we decided against a notification or email and just went for the blog posts.

@atorstling

This comment has been minimized.

atorstling commented Apr 10, 2017

Alright. Did you also write anything about "#heading" not rendering as a heading anymore? (https://talk.commonmark.org/t/heading-not-working/819) I got that on multiple repositories myself, I had sort of applied that universally :)

@atorstling

This comment has been minimized.

atorstling commented Apr 10, 2017

Would have been cool if you could have detected rendering issues and flagged them to the owners somehow.

@atorstling

This comment has been minimized.

atorstling commented Apr 10, 2017

I googled "##documentation" site:github.com filetype:md and got around 1 million hits. That might not be representative and was the worst case I could find, but still a lot of users might be affected.

Snaipe added a commit to Snaipe/Criterion that referenced this issue May 22, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment