Skip to content

Conversation

@ovflowd
Copy link
Member

@ovflowd ovflowd commented Mar 15, 2023

This PR introduces the GitHub Flavoured Markdown Plugin (Remark) and updates the Release Blog Post script to follow the Hard Line convention from CommonMark.

It also updates all existing blog posts to follow that convention.


Reasoning behind:

When we switched to MDXJS as the Parser for Markdown, it meant that we also adopted the standard CommonMark specification for Markdown. Whilst most of the Markdown files got fixed, and whilst <br /> tags are technically not invalid CommonMark syntax, they're not part of the specification.

Thus, we needed to update the blog posts to follow the specification.

Closes #5146

@ovflowd ovflowd requested review from richardlau and targos March 15, 2023 19:28
@ovflowd ovflowd merged commit 2c381b2 into nodejs:main Mar 15, 2023
@nschonni
Copy link
Member

Cleanup looks good, I'd just raise the comment on the other issue, that if all these are getting touched, they might make more sense as a list

@ovflowd ovflowd deleted the fix/release-blog-posts branch March 15, 2023 19:55
@ovflowd
Copy link
Member Author

ovflowd commented Mar 15, 2023

Cleanup looks good, I'd just raise the comment on the other issue, that if all these are getting touched, they might make more sense as a list

Oh F, just saw your comment now 😅

I think we can do a follow-up

@nschonni
Copy link
Member

yeah, no worries, the current solution is fine, and is easy enough to find/replace again. I don't think the list would need the GFM extra, since the lists on the posts already seem to behave OK. This is probably more in line with the formatting that's used on the GitHub Release formatting, so I don't think it really needs to change again

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Formatting for release blog post downloads

3 participants