HTML headings with line breaks -> no heading and inconsistency between preview and rendered post

AI-generated summary

A bug was reported where HTML headings containing line breaks are not rendered correctly in baked posts on Discourse, despite appearing fine in previews. The issue causes the heading tag to be left empty and the text wrapped in a <p> tag instead, e.g., <h2></h2><p>Heading test with line breaks</p> rahim123. Initial suspicion pointed to the CSS flipper, but Osama ruled it out, confirming the problem lies in post cooking. Selase traced it to the Markdown parser (PrettyText.markdown) wrapping header content in <p> tags during parsing, which then get extracted during scrubbing — likely because paragraphs inside headers aren’t HTML spec-compliant. Sam linked this to a similar issue and noted it may require waiting for a Loofah update. rahim123 clarified that HTML itself allows line breaks in headings, so the issue stems from Markdown processing after HTML parsing. The bug was fixed in PR #21522 by nat, restoring correct rendering. However, existing posts must be manually rebaked to reflect the fix, as automatic rebaking is too resource-intensive nat.

Hi there, I have some posts imported from another forum software with line breaks in headings. These are shown correctly in the post preview, but they are not rendered as headings in the final baked post. I’m seeing this issue on my forum updated yesterday and also here on Discourse Meta:


Heading test with line breaks

Normal paragraph.

Heading with no line breaks


It’s leaving the <h2> blank and is wrapping the text after that in <p> :

<h2 dir="ltr">
</h2><p dir="ltr">Heading test with line breaks</p>

I’m 99% sure that this is a recent regression, as I specifically checked headings in imported posts from the same user during the migration process, and the user and I both remember that they were rendered correctly.

2 Likes

Hmm given the ltr stuff there @Osama could this be related to the CSS flipper we recently added?

2 Likes

I don’t think so because the final/cooked HTML of the post is wrong and the CSS flipper (whether the old or the new one) isn’t involved at all in the post cooking process.

^ the text inside the <p> should be inside the <h2> and there should be no <p> at all (I think).

6 Likes

This seems to happen during cooking, specifically markdown parsing.

Passing a header with linebreaks to PrettyText.markdown returns with the content of header wrapped in a p tag.

And then during scrubbing, the paragraph get’s extracted out out of the header tag resulting in the following:

I suppose this happens since a paragraph in a header tag isn’t spec compliant?

I’m still reviewing the markdown parser code to figure out why the content is being wrapped in p tag in the first place.

2 Likes

Oh this is very related to:

I am OK to wait a few more weeks for Loofah to release

Will shoot out a Tweet to Mike to mention this popped up.

2 Likes

Hi there, thanks for looking into this. HTML doesn’t care about line breaks, so technically this is correct:

<h2>

Heading test with line breaks

</h2>

It simply seems to be a problem of the Markdown parser running after/inside the HTML parser, which is generating <p> tags for the line returns.

1 Like

Hey there, we’ve fixed this with

https://github.com/discourse/discourse/pull/21522

as seen here:

Heading test with line breaks

Normal paragraph.

Heading with no line breaks


8 Likes

Glad to hear, thanks @nat! Does this require rebaking posts?

2 Likes

Yes, it does require a rebake — we can’t do it for you automatically with this fix since it’s an expensive operation.

3 Likes

This topic was automatically closed after 2 days. New replies are no longer allowed.