Allow registering remark plugins #5633
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
erezrokah
added
the
type: feature
|
hmm not sure about the failing e2e test - it seems to work fine running locally |
I think it's unrelated. Some tests are flaky on CI |
erezrokah
suggested changes
Jul 21, 2021
There was a problem hiding this comment.
Thanks @stefanprobst for this great PR and for adding tests and docs too!
I've added some comments, please let me know what you think.
packages/netlify-cms-widget-markdown/src/MarkdownControl/VisualEditor.js
Show resolved
Hide resolved
packages/netlify-cms-widget-markdown/src/serializers/__tests__/remarkPlugins.spec.js
Outdated
Show resolved
Hide resolved
packages/netlify-cms-widget-markdown/src/serializers/__tests__/remarkPlugins.spec.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Erez Rokah <[email protected]>
…/remarkPlugins.spec.js Co-authored-by: Erez Rokah <[email protected]>
…/remarkPlugins.spec.js Co-authored-by: Erez Rokah <[email protected]>
erezrokah
approved these changes
Jul 25, 2021
There was a problem hiding this comment.
This looks 🚀 @stefanprobst. I refactored the code a bit to pass the plugins as an option property instead of an additional argument.
erezrokah
force-pushed
the
feat/allow-remark-plugins
branch
from
e9f5cce to
e7ba75f
Compare
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.
Summary
This PR allows registering remark plugins (and presets) to customize how markdown is serialized/deserialized in the richtext editor.
Two usecases which have come up are (i) avoid saving autolinks for mdx-compatibility, and (ii) enforce formatting options.
fixes: #5516
related: #4601
did not mark #4601 as fixed, because this only affects how the richtext editor serializes to markdown. to enforce formatting for the markdown editor, the plaintext content would probably have to be run through a remark pipeline here but that means text would change while typing, which is odd (i also ran into issues where the textarea lost focus while typing when i tried it).
(sorry for the formatting chages, these were done by
yarn format)Test plan
Added seriailzer tests.
Checklist
Please add a
xinside each checkbox:yarn format.yarn test.