Skip to content
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

docs: Suggest remark-cjk-friendly in migration guide #10892

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Feb 2, 2025

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

It requires a lot of effort to ensure to replace all * and ** not recognized as emphasis markers by CommonMark/MDXv2+ with <em> and <strong> in large CJK documents. I think they cannot be found by a simple regex. It is much easier to depend on remark-cjk-friendly remark plugin for CJK documents.

Test Plan

Check the changed page and confirm it looks great

Test links

Deploy preview: https://deploy-preview-10892--docusaurus-2.netlify.app/docs/migration/v3/#emphasis-starting-or-ending-with-a-space-or-a-punctuation

Related issues/PRs

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 2, 2025
Copy link

netlify bot commented Feb 2, 2025

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 3d35399
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/679f6b04fc7c670008fde7ff
😎 Deploy Preview https://deploy-preview-10892--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Feb 2, 2025

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🔴 38 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🔴 46 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 72 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 54 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 66 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 62 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 73 🟢 100 🟢 100 🟠 86 Report

@slorber slorber changed the title Suggest remark-cjk-friendly in migration guide docs: Suggest remark-cjk-friendly in migration guide Feb 3, 2025
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

@slorber slorber merged commit a0248ed into facebook:main Feb 3, 2025
18 checks passed
@tats-u tats-u deleted the cjk-friendly-remark-plugin branch February 3, 2025 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants