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

[#56779] Allow empty lines in rich text #16620

Draft
wants to merge 13 commits into
base: dev
Choose a base branch
from

Conversation

as-op
Copy link
Contributor

@as-op as-op commented Sep 4, 2024

Ticket

https://community.openproject.org/work_packages/56779

What are you trying to accomplish?

Allow empty lines everywhere in our rich text (markdown with html)

Screenshots

What approach did you choose and why?

Support blank lines on markdown root level

Markdown does not support multiple blank lines. So I adapted the format supported by most markdown parsers/renderers.

First line

<br>

<br>

Fourth line

(First line\n\n<br>\n\n<br>\n\nFourth line)

compatible with:

  • GIthub
  • markdown => HTML pipeline in OpenProject
  • md-to-pdf
  • markdown => html => CKeditor conversion support added
  • CKeditor => html => markdown conversion support added

Support blank lines in table cells

We store tables as HTML, so we just need to preserve empty lines as paragraphs <p><br></p>

compatible with:

Support blank lines in lists

As for empty lines on root level, blank lines in lists are not supported by markdown, therefor we use the same method.

*  Start item

   <br>

   <br>

   End

*  Second item

compatible with:

Support blank lines in code blocks

Empty markdown code blocks are inflated to have at least one empty line

compatible with:

  • GIthub

  • markdown => HTML pipeline in OpenProject

  • markdown => html => CKeditor conversion support added

  • CKeditor => html => markdown conversion support added

  • Check md-to-pdf

Merge checklist

  • Added/updated tests
  • Added/updated documentation in Lookbook (patterns, previews, etc)
  • Tested major browsers (Chrome, Firefox, Edge, ...)

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

Successfully merging this pull request may close these issues.

1 participant