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.

Sign up for GitHub

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

Update README.md - add internationalization instructions #7

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Update README.md - add internationalization instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,15 @@ npm install @giscus/react
npm run build
npm run serve
```

## Internationalization and Translation
The purpose of this section is to offer a cheatsheet for adding an new locale and translations. Here are the details:
- Start with the [docusaurus internationalization introduction and 3 sub-pages](https://docusaurus.io/docs/i18n/introduction).
- Quick notes:
- Modify docusaurus.config.js to include your [desired locale](https://saimana.com/list-of-country-locale-code/) (example: locales: ['en', 'fr', 'fa'],)
- Run the command to write the translation details
- npm run write-translations -- --locale es
- Assuming you are manually translating your document (not using Crowdin), execute the mkdir/copy statements from here:
- https://docusaurus.io/docs/i18n/git
- Start translating...
- Note: copying over the files to be translated is essentially like forking the documentation. It is recommended that you wait until the English docs are near-complete before copying over the content to minimize syncing efforts for future edits.