3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 00:39:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: normalize capitalization (#7619)

Browse source
This commit is contained in:
Joshua Chen 2022-06-15 13:04:33 +08:00 • committed by GitHub
parent aeb6c971c0
commit e12a2efaeb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 99 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/i18n/i18n-crowdin.mdx
View file

@ -444,7 +444,7 @@ Crowdin has an [In-Context localization](https://support.crowdin.com/in-context-
Unfortunately, it does not work yet for technical reasons, but we have good hope it can be solved.
Crowdin replaces markdown strings with technical ids such as `crowdin:id12345`, but it does so too aggressively, including hidden strings, and messes up with front matter, admonitions, JSX...
Crowdin replaces Markdown strings with technical IDs such as `crowdin:id12345`, but it does so too aggressively, including hidden strings, and messes up with front matter, admonitions, JSX...
:::

8
website/docs/i18n/i18n-tutorial.md
View file

@ -420,18 +420,18 @@ We only copy `.md` and `.mdx` files, as React pages are translated through JSON
:::
:::tip Use explicit heading ids
:::tip Use explicit heading IDs
By default, a Markdown heading `### Hello World` will have a generated id `hello-world`. Other documents can link it with `[link](#hello-world)`. However, after translation, the heading becomes `### Bonjour le Monde`, with id `bonjour-le-monde`.
By default, a Markdown heading `### Hello World` will have a generated ID `hello-world`. Other documents can link it with `[link](#hello-world)`. However, after translation, the heading becomes `### Bonjour le Monde`, with ID `bonjour-le-monde`.
Generated ids are not always a good fit for localized sites, as it requires you to localize all the anchor links:
Generated IDs are not always a good fit for localized sites, as it requires you to localize all the anchor links:
```diff
- [link](#hello-world).
+ [link](#bonjour-le-monde)
```
For localized sites, it is recommended to use **[explicit heading ids](../guides/markdown-features/markdown-features-toc.mdx#explicit-ids)**.
For localized sites, it is recommended to use **[explicit heading IDs](../guides/markdown-features/markdown-features-toc.mdx#explicit-ids)**.
:::