search

nestdotland / nest.land

🦕 The Nest Website
https://nest.land
MIT License
371 stars 19 forks source link

Markdown single newlines are rendered as paragraph boundaries #275

Open srackham opened 3 years ago

srackham commented 3 years ago

Single newlines are rendered as paragraph boundaries and consequently Markdown documentation not formatted correctly.

For example, compare the opening paragraph this README on Github and on nest.land:

ebebbington commented 3 years ago

FYI GH seem quite inconsistent with this... whilst they aren't a new paragraph in README's, they are in issues

srackham commented 3 years ago

@ebebbington Yes, GH is inconsistent, but they admitted that this behaviour was a mistake back in 2014. The point is that the behaviour does not conform to the Markdown specification.

t8 commented 3 years ago

Hey @srackham! So sorry for the late reply to this.

I see your point on the opening lines of the drake module README. This is likely something that needs to be fixed with the markdown formatter we currently used.

CC @martonlederer

martonlederer commented 3 years ago

Yeah sadly we can't really fix that