-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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: add admonition for incompatibility with *
and **
in Chinese and Japanese in MDX v2+
#9692
Conversation
@Josh-Cena I would appreciate if you could provide a Chinese example. |
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
*
and **
in MDX v2+*
and **
in Chinese and Japanese in MDX v2+
⚡️ Lighthouse report for the deploy preview of this PR
|
ee9df12
to
73b5e1e
Compare
Thanks @tats-u don't forget to add a link to your docs edit preview in the PR, that makes it much faster to review for others: This is a long text for a little issue. The goal here is not to document them all exhaustively and overwhelm users that migrate, most of them are not Chinese/japanese. What about putting most of that content in |
I had thought that is not necessary. I have fixed the description and will add ones from an next PR.
I doubt this because the official site of Docusaurus is also affected. https://docusaurus-i18n-staging.netlify.app/ja/docs https://docusaurus.io/zh-CN/docs/next https://docusaurus-i18n-staging.netlify.app/ja/docs/static-assets#in-css Note: Chinese has avoided this by adding an additional space. https://docusaurus.io/zh-CN/docs/next/static-assets#in-css I believe it is too frequent to be pushed into a detail element. Also it is difficult for most Chinese and Japanese users to understand the trigger condition of this problem by themselves. They will have to gaze into the CM spec, which is not for users, to find out the condition. According to https://www.meilisearch.com/docs/learn/what_is_meilisearch/language, some other languages can be said to be affected:
Even if it were adopted, at least |
I'm ok to have a clear and concise description of the problem, including a list of all languages possibly affected, but I'd like to keep it short for others. Maybe at least put most of the examples in details element?
Hmm why not, but is this really necessary? We can just say that those supporting a list of languages should rather pay more attention to the following section. |
@slorber I found that it looks better to use |
db0f9a3
to
85ad9a7
Compare
@slorber I will use |
Thanks 👍 I think it's still a bit too verbose, but let's move on |
Docs backports happen on |
That makes sense. Thank you for providing the helpful information. |
Pre-flight checklist
Motivation
**
in**重要的中文。**其他的中文。
and**重要な日本語の文。**別の日本語の文。
will not treated as<strong>
due to a regression in CommonMark spec 0.14+.MDX v2+ strictly follow CM and have this regression.
commonmark/commonmark-spec#650
Test Plan
Test links
https://deploy-preview-9692--docusaurus-2.netlify.app/docs/migration/v3/#other-markdown-incompatibilities
Related issues/PRs
commonmark/commonmark-spec#650