Skip to content

Unwanted characters in docs after Prettier #11772

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.

Sign up for GitHub

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

Jump to bottom
Closed
bratvanov opened this issue Mar 19, 2025 · 2 comments · Fixed by #11784
Closed

Unwanted characters in docs after Prettier #11772

bratvanov opened this issue Mar 19, 2025 · 2 comments · Fixed by #11784
Assignees
@AlessioGr
Labels
created-by: Contributor documentation Improvements or additions to documentation

Comments

@bratvanov
Copy link
Contributor

bratvanov commented Mar 19, 2025 •
edited
Loading

Documentation Issue

I noticed some side-effects in the docs after this commit which re-enabled Prettier.

Additional Details

Required fields designated by * now have extra escaping slashes added from Prettier in the actual Markdown files.

These are rendered in the docs on the site, but not in the GitHub markdown preview, which makes me think that perhaps richtext-lexical and/or the Markdown -> HTML converter might need to be tweaked to handle these, rather than simply removing the extra slashes?

Some examples (mostly occurs in tables, but also in body text as well)

In the same commit, {' '} was added twice in the Note from Prettier:
@bratvanov bratvanov added the documentation Improvements or additions to documentation label Mar 19, 2025
@AlessioGr AlessioGr self-assigned this Mar 19, 2025
@AlessioGr AlessioGr mentioned this issue Mar 20, 2025
Merged
@AlessioGr AlessioGr linked a pull request Mar 20, 2025 that will close this issue
feat(richtext-lexical): support escaping markdown characters #11784
Merged
AlessioGr added a commit that referenced this issue Mar 20, 2025
@AlessioGr
feat(richtext-lexical): support escaping markdown characters (#11784)
43cdccd 
Fixes #10289 and
#11772

This adds support for escaping markdown characters. For example,` \*` is
supposed to be imported as `*` and exported back to `\*`.

Equivalent PR in lexical repo:
facebook/lexical#7353
@github-actions GitHub Actions
Copy link
Contributor

🚀 This is included in version v3.29.0

@github-actions GitHub Actions
Copy link
Contributor

This issue has been automatically locked.
Please open a new issue if this issue persists with any additional detail.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@AlessioGr AlessioGr

Labels
created-by: Contributor documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(richtext-lexical): support escaping markdown characters payloadcms/payload
2 participants
@bratvanov @AlessioGr