-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Replaced deprecated markdown-to-react-components with marksy
#1188
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
Conversation
…in addon-info to use marksy
|
Thanks @ranneyd for diagnosing the problem and then fixing it. You rock! 👊 Edited the PR description slightly. Code looks great. I'll test it out on my machine and merge if it works. Many thanks! |
markdown-to-react-components with marksy
Codecov Report
@@ Coverage Diff @@
## master #1188 +/- ##
=======================================
Coverage 13.31% 13.31%
=======================================
Files 199 199
Lines 4588 4588
Branches 531 540 +9
=======================================
Hits 611 611
+ Misses 3501 3492 -9
- Partials 476 485 +9
Continue to review full report at Codecov.
|
shilman
left a comment
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.
@ranneyd Looks like you need to update package.json to add marksy and remove markdown-to-react-components?
|
I actually had but I accidentally undid that change. Fixing now. |
|
@shilman try it now. Let me know how it goes! |
shilman
left a comment
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.
@ranneyd Figured you must have made the changes at some point to get this working. Looks great and thanks so much for contributing! 🏅 Merging.
Issue: #1114
What I did
Looking at issue 1114 (#1114)...
The error came from a package called
markdown-to-react-components. Looking at this package's github (https://github.com/christianalfoni/markdown-to-react-components) it's clear that the package is deprecated. They recommend usingmarksy(https://github.com/cerebral/marksy).Marksy appears to be a fork of
markdown-to-react-componentsbecause the APIs are almost identical (namely, the configuration is exactly the same). This made swapping out the old version for the new one very easy, which is what I did. I also updated the name of the config (which can be passed as an argument to this addon) to reflect the new underlying mechanism.How to test