Replace Redcarpet by CommonMarker #419
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
torrocus
reviewed
Nov 15, 2023
torrocus
requested changes
Nov 15, 2023
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
from
d5da141 to
eaafce3
Compare
torrocus
reviewed
Nov 16, 2023
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
from
eaafce3 to
a35df6f
Compare
torrocus
reviewed
Nov 16, 2023
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
from
a35df6f to
7174310
Compare
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
torrocus
reviewed
Nov 16, 2023
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
2 times, most recently
from
d9588a5 to
46b32a7
Compare
torrocus
reviewed
Nov 16, 2023
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
2 times, most recently
from
52ee84e to
1d61211
Compare
torrocus
reviewed
Nov 16, 2023
spec/lib/markdown_spec.rb
Outdated
Comment on lines
92
to
93
| expected_result_in_html = '<p><a href="https://fractalsoft.org/">' \ | ||
| "<img src=\"/path/to/my_image\" alt=\"My image\" /></a></p>\n" |
There was a problem hiding this comment.
Suggested change
| expected_result_in_html = '<p><a href="https://fractalsoft.org/">' \ | |
| "<img src=\"/path/to/my_image\" alt=\"My image\" /></a></p>\n" | |
| expected_result_in_html = <<~HTML | |
| <p><a href="https://fractalsoft.org/"><img src="/path/to/image" alt="My image" /></a></p> | |
| HTML |
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
from
1d61211 to
424a486
Compare
We were missing tests to check the conversion from Markdown to HTML. While writing the missing tests, I found out that some implementations for using Redcarpet didn't work. We had added some Redcarpet extensions, [1] but they did not load in the application when we used them. To be more specific, the Redcarpet extensions were not enabled in the application where we were using them. This was the reason for refactoring the code. The tests that check for correct conversion of Markdown to HTML with Redcarpet pass. [1]: https://www.writesoftwarewell.com/how-to-render-markdown-views-in-rails/
> Ruby wrapper for the comrak (CommonMark parser) Rust crate [1] [1]: https://github.com/gjtorikian/commonmarker
We replace Redcarpet with CommonMarker [1] because the latter has more features and is faster. [2] This helps to render HTML from Markdown better. I had to refactor the tests due this change. [1]: https://github.com/gjtorikian/commonmarker/blob/v1.0.0.pre11/README.md [2]: https://github.github.com/gfm/
Since Redcarpet [1] is not used anywhere, I have removed it. [1]: https://github.com/vmg/redcarpet
ania-hm
force-pushed
the
ab-replace-redcarpet-to-commonmarker
branch
from
424a486 to
aa89b81
Compare
torrocus
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Summary
It is part of a larger task to add pages describing industries where we can help as programmers. CommonMarker has more features and is faster than Redcarpet. This helps for better rendering of HTML from Markdown.
Feedback
N/A
UI Changes
N/A