-
Notifications
You must be signed in to change notification settings - Fork 75
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
Preserve line breaks in markdown #1241
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #1241 +/- ##
==========================================
+ Coverage 53.41% 53.44% +0.03%
==========================================
Files 103 103
Lines 2928 2928
Branches 544 544
==========================================
+ Hits 1564 1565 +1
Misses 1014 1014
+ Partials 350 349 -1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! For reference, here's what the sample text looks like without this PR
Just a minor thing: the PR title is a bit confusing - I think changing it to your commit title would be better.
Also, I think you can explore upgrading our ngx-markdown version to enable gfmd as you mentioned in #1230
Actually I realised that ngx-markdown documentation was actually outdated/incorrect. Also, GFMD was already enabled in CATcher, so right now the current ngx-markdown version is sufficient. We probably can explore upgrading ngx-markdown version when we upgrade the packages/angular/node version. |
* Fix broken duplicate link (#1233) Fix the broken link of a duplicate issue Currently, the user cannot open the link to a duplicate issue when opening an issue, as described in #1228. The links now work as expected. * Add whitespace validation (#1237) * Add whitespace validation * Update whitespace validation for new issue * Update whitespace validation for title of new issues * Update whitespace validation for title of new issues * Move validators into core * Update import order --------- Co-authored-by: Misra Aditya <[email protected]> * Fix uncaught errors when attempting to access an invalid route There is an uncaught error when the users click on an invalid internal link in Markdown or enter an invalid link in browser. Internal links are unlikely to be used for bug reporting and are more likely to be invalid. Let's show an error toaster and stop the navigation when clicking on an internal link in Markdown. Also, redirect the users to the login page if the users enter invalid link in browser. * Set default branch to `main` Previously, image uploads depend on the user's default branch. Now, we set the branch for image upload to be `main`. Images will be uploaded to `main` as a result. --------- Co-authored-by: Chee Hong <[email protected]> * Preserve linebreaks (#1241) With preserving linebreaks, subset list items are rendered as a list, and paragraph rendering is the same as Github. * Faulty list view when back navigating (#1243) Issue table settings such as page index are not saved when table is re-mounted. This behavior inconveniences users as their settings are reset everytime they navigate to a specific issue and back. Let's lift up the table settings of each mounted table to a service which the tables pull from when mounted. * Upgrade to Angular 12 (#1242) Some of our packages are old and outdated. We should actively maintain and keep these packages up-to-date so it is easier to maintain in the future. Let's upgrade to Angular 12 to keep our packages up-to-date. * Fix markdown blockquote preview difference (#1245) Due to DOMPurify, the content used for preview is different. However, given that ngx-markdown already has sufficient sanitation by default, we remove sanitation by DOMPurify. * Create release for v3.5.3 --------- Co-authored-by: Nguyen <[email protected]> Co-authored-by: AdityaMisra <[email protected]> Co-authored-by: Misra Aditya <[email protected]> Co-authored-by: NereusWB922 <[email protected]> Co-authored-by: Chee Hong <[email protected]> Co-authored-by: Arif Khalid <[email protected]>
Summary:
Fixes #1230
Changes Made:
breaks
option in the app module markdown declaration.Note that in #1230, the subset list is not exactly rendered as a list, but is rendered with linebreaks.
Github preserves linebreaks when rendering markdown, hence it looks like the items are rendered as list items.
One consequence of this PR is that, whenever two sentences are separated only by one line break, in html, instead of the two being one paragraph (as expected from standard markdown syntax), the two are preserved and rendered as two paragraphs (as expected behaviour of github markdown).
Summarising everything in one example, the following markdown code:
is rendered as:
Proposed Commit Message: