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

Unexpected markdown rendering: newlines #193

Closed
cerisara opened this issue Oct 6, 2019 · 3 comments
Closed

Unexpected markdown rendering: newlines #193

cerisara opened this issue Oct 6, 2019 · 3 comments

Comments

@cerisara
Copy link

cerisara commented Oct 6, 2019

When writing a post, I assume I'm writing in some flavor or markdown.
But then, it's pretty surprising to see that every newline that I insert in my blog
is rendered as a newline: I'd expect in markdown paragraphs to be separated by an empty line,
and not by a newline.

The expected rendered output, in order to better comply with standard markdown rendering, would be to join all the lines together into a single paragraph until an empty line is found.

Thanks for the great software !

@ghost
Copy link

ghost commented Oct 6, 2019

Hi @cerisara, thanks for the issue report. 😃

Can you show an example of a post that is not behaving as expected?

Also can you define a newline and an empty line, so I know the HTML you are expecting?

I tried a small test and found the following:

  • a sentence broken by a single new line remains part of the same logical paragraph, but that newline is preserved. (same as github flavor but they use a line break)
  • a sentence broken by a double space and then a new line inserts a line break, still the same logical paragraph.
  • a sentence broken by an empty line create two separate paragraphs.

Behind the scenes we are using github.com/russross, as far as I can tell we are not changing any default line/new line behaviour. @thebaer may know more about that.

All that said, I'm eager to get this all sorted out for you.

@thebaer
Copy link
Member

thebaer commented Oct 7, 2019

Thanks for the input @cerisara!

This is indeed an ongoing discussion we've been having. But the choice for honoring newlines exactly as they're typed was a deliberate design decision, to make the platform usable for such writing as poetry. (As such, I'll close this issue -- but feel free to continue discussing.)

Still, we'd like to potentially support different Markdown flavors, configured at the instance-level. If you have any thoughts on a standard we should use, we'd love to hear about it.

@cerisara
Copy link
Author

cerisara commented Oct 7, 2019

Thank you both of you for your reply !
OK, I understand the design decision, especially with regard to writing poetry: it's definitely better for this use case. It's probably not as good for another use case: when people are syncing their blog with a git server (in addition to publishing them on writefreely), because long lines are bad for git. They might also be not so nice to navigate in in post-edition.
But it's clear that there's a compromise to find for the default behaviour: then, it'd be great to indeed have the choice, at the instance or blog level ! :-)
Thanks again.

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

No branches or pull requests

2 participants