-
-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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: improve escape pipe in Markdown tables #5539
Conversation
From a remark on Crowdin: > The value for the Type entry in the plugin-content-blog page is strange. > In English documents, the Type item value is normally displayed. > ex) editUrl: string | EditUrlFunction > However, in French documentation, the Type item value is shown as an unknown code. > ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!! > ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!! This is a test to see if the other way to escape a pipe in a markdown table could solve the problem.
✔️ [V2] 🔨 Explore the source changes: 15d7ad0 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/613896c4f0e4790007cf4268 😎 Browse the preview: https://deploy-preview-5539--docusaurus-2.netlify.app |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5539--docusaurus-2.netlify.app/ |
Can we also fix this in other places? In |
@Josh-Cena That's what I was thinking of doing in a second step, but I'd like to check that it fixes the problem in Crowdin first |
Yes, but even if it doesn't, it improves readability (I didn't like the HTML entities either but didn't even think |
@Josh-Cena Ok I will modify all the docs |
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.6/api/themes/theme-configuration.md
Outdated
Show resolved
Hide resolved
@forresst looks good to me, can I merge it? |
@lex111 Perfect! Thanks! You can merge it! |
@forresst thanks! |
Unfortunately, this still does not solve the problem in Crowdin 😢 |
My second guess is the |
@Josh-Cena I think you are right. the
|
I'm not sure if Crowdin has a playground or something like that (FYI slorber on vacation).
|
@lex111 The original intent was to have the notation resemble TS—we have |
I misspelled, of course we are talking about types, not values. And it is unlikely that such change would worsen the understanding about Possible Types of fields. In our situation it would be a good compromise, so let's give it a try. We could even use just white space as a separator instead of comma. |
Hey, created a dedicated issue and will ping Crowdin support about it: #5602 |
From a remark on Crowdin:
I think that the string
<code> 'light' | 'dark' </code>
is blocked by Crowdin because of the pipe escapeThis is a test to see if the other way to escape a pipe in a markdown table could solve the problem.
Motivation
First, see if the preview of this page works well in Docusaurus.
In a second time, if the first point works, see if it unblocks the problem in Crowdin
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Related PRs
None