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

Paradox introduces extra line breaks #382

Closed
jrudolph opened this issue Oct 11, 2016 · 5 comments · Fixed by #444
Closed

Paradox introduces extra line breaks #382

jrudolph opened this issue Oct 11, 2016 · 5 comments · Fixed by #444
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation
Milestone

Comments

@jrudolph
Copy link
Member

Markdown usually ignores line breaks, so that the md source files can be arranged in a way that is readable without an editor that wraps long lines. It seems the current documentation workflow inserts <br/> instead leading to somewhat ugly formatting:

screenshot from 2016-10-11 16 57 16

Any idea, how to change that @jonas?

@jrudolph jrudolph added help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted labels Oct 11, 2016
@jrudolph jrudolph added this to the 2.4.11 milestone Oct 11, 2016
@jrudolph
Copy link
Member Author

Added lightbend/paradox#31 to review whether HARDWRAPS was intended or an accidental parsing option.

@jonas
Copy link
Member

jonas commented Oct 11, 2016

I believe the original Markdown flavour specifies to honour line breaks, mainly to support proper formatting in block quotes. GFM which Paradox "embraces" does not I was also planning to submit a patch to fix it in Paradox.

Any Lightbend docs that already uses Paradox will have to explicitly format haiku poems and what not. ;)

@jrudolph
Copy link
Member Author

I believe the original Markdown flavour specifies to honour line breaks

Don't think so. See http://daringfireball.net/projects/markdown/basics:

Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.

is converted into

<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>

That's also how CommonMark defines paragraphs (http://spec.commonmark.org/0.25/#paragraphs):

A sequence of non-blank lines that cannot be interpreted as other kinds of blocks forms a paragraph. The contents of the paragraph are the result of parsing the paragraph’s raw content as inlines. The paragraph’s raw content is formed by concatenating the lines and removing initial and final whitespace.

mainly to support proper formatting in block quotes

This is unrelated. Blockquotes are parsed / output differently.

Any Lightbend docs that already uses Paradox will have to explicitly format haiku poems and what not. ;)

Yes, this is a valid concern. Forcing Haikus between blockquotes might seem like an overly harsh restriction on creative freedom.

@jonas
Copy link
Member

jonas commented Oct 11, 2016

Yes, you are right. Hope the PR gets merged soon.

@jrudolph
Copy link
Member Author

Paradox has been fixed. Waiting for a new version...

@jrudolph jrudolph modified the milestones: 2.4.11, 3.0.0 Oct 17, 2016
jonas added a commit to jonas/akka-http that referenced this issue Oct 28, 2016
jrudolph added a commit that referenced this issue Nov 1, 2016
Upgrade Paradox, use callouts and fix Java links, fixes #382
@ktoso ktoso modified the milestones: 10.0.0 "first stable", Final HTTP/2, 10.0.0-RC2 Nov 10, 2016
jedrekn pushed a commit to jedrekn/akka-http that referenced this issue Nov 17, 2016
jedrekn pushed a commit to jedrekn/akka-http that referenced this issue Nov 17, 2016
Upgrade Paradox, use callouts and fix Java links, fixes akka#382
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants