История

Erick Zhao fb5a601db7 docs: update i18n/README.md (#531 )		2024-03-04 13:06:01 -08:00
..
en	build(i18n): update write-translations (#414 )	2023-05-24 22:55:15 -04:00
readme.md	docs: update i18n/README.md (#531 )	2024-03-04 13:06:01 -08:00

readme.md

About en-US

TL;DR; Do not manually modify the contents of i18n/en-US.

Docusaurus translations for anything that is not markdown are stored in several JSON files. These files are generated for each locale from the contents of docusaurus.config.js, sidebars.js, and installed plugins using the yarn write-translations --locale [locale] script. Some of the files that are generated are code.json, navbar.json, footer.json, etc.

For the website's source language (en-US), these JSON files are not used by Docusaurus. Rather, they serve as source files for our Crowdin internationalization (i18n) workflow.

To keep everything in sync, there is a pre-commit hook that automatically deletes and creates again the en-US folder and its contents when docusaurus.config.js or sidebars.js are modified. The script the hook invokes is in /scripts/update-l10n-sources.ts.

For details on how to contribute to the i18n of the Electron docs, please see i18n.md.