mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 08:12:00 +02:00
docs: add how to add a language (#732)
* Create language-contributions.md * Update language-contributions.md * Update README.md * Update mkdocs.yml * Update README.md * Update language-contributions.md * Create languages.md * Update languages.md * Update README.md * Update mkdocs.yml * fix space languages.md fix space at line 61
This commit is contained in:
Marco Beretta
GitHub
parent
851dce720f
commit
0630b54193
4 changed files with 197 additions and 2 deletions
|
|
@ -73,6 +73,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
|
|||
* [APIs and Tokens](docs/install/apis_and_tokens.md)
|
||||
* [User Auth System](docs/install/user_auth_system.md)
|
||||
* [Online MongoDB Database](docs/install/mongodb.md)
|
||||
* [Languages](docs/install/languages.md)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
|
@ -112,7 +113,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
|
|||
|
||||
<details>
|
||||
<summary><strong>Contributions</strong></summary>
|
||||
|
||||
|
||||
* [Contributor Guidelines](CONTRIBUTING.md)
|
||||
* [Documentation Guidelines](docs/contributions/documentation_guidelines.md)
|
||||
* [Code Standards and Conventions](docs/contributions/coding_conventions.md)
|
||||
|
|
|
|||
80
docs/contributions/language-contributions.md
Normal file
80
docs/contributions/language-contributions.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
# How to add a language to LibreChat
|
||||
|
||||
## Minimum Requirements:
|
||||
|
||||
1. Good knowledge of the language (some terms may undergo significant changes during translation)
|
||||
2. An editor, which can be Notepad or (**recommended**: [VSCode](https://code.visualstudio.com/download))
|
||||
|
||||
## Language translation
|
||||
|
||||
|
||||
1. Fork the LibreChat repository and download it using git clone https://github.com/danny-avila/LibreChat
|
||||
2. Navigate to the "client\src\localization" folder and open the "Translation.tsx" file
|
||||
3. At the beginning of the code, add your language below all the others in this format:
|
||||
|
||||
`import Language-name from './languages/** ';`
|
||||
|
||||
For example, let's take English as an example:
|
||||
|
||||
Note: Replace "LanguageName" with the name of your language (capitalized) and "**" with the ISO 3166 Alpha-2 code of your country (the initial of the nation).
|
||||
If you don't know the ISO 3166 code for your language, check it [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) and also use it with an initial capital)
|
||||
|
||||
4. Further down in the code, add the following
|
||||
|
||||
`if (langCode === '**') return Language-name;`
|
||||
|
||||
Replace "**" with the ISO 3166 Alpha-2 code of your language (in lowercase). Here's an example: `if (langCode === 'en') return English;`)
|
||||
|
||||
7.Go into the "languages" folder and create a file named as follows: **.tsx
|
||||
|
||||
For example: En.tsx
|
||||
|
||||
9. Copy all the content from En.tsx into your file and modify it as follows:
|
||||
|
||||
```
|
||||
// your-language-name phrases
|
||||
|
||||
export default {
|
||||
com_ui_examples: 'Examples',
|
||||
// Add more translations here
|
||||
```
|
||||
|
||||
Rename only the part after the colon ":" to the corresponding translation in your language. For example:
|
||||
|
||||
```
|
||||
// my-language phrases
|
||||
|
||||
export default {
|
||||
com_ui_examples: 'WORD_THAT_I_TRANSLATE_IN_TO_MY_LANGUAGE',
|
||||
// Add more translations here
|
||||
};
|
||||
```
|
||||
|
||||
⚠️DO NOT CHANGE com_... ⚠️
|
||||
|
||||
10. To add your language to the menu, open the file "client\src\components\Nav\SettingsTabs\General.tsx" and add your language to the "LangSelector" variable in the following way:
|
||||
|
||||
```
|
||||
export const LangSelector = ({
|
||||
//other code
|
||||
<option value="en">{localize(lang, 'com_nav_lang_english')}</option>
|
||||
//other languages...
|
||||
<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
|
||||
</select>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
where ** is the ISO 3166 Alpha-2 code and "com_nav_lang_your-language-name" stands for the name in your language (for example com_nav_lang_english or com_nav_lang_italian)
|
||||
The only line of code to add is:
|
||||
|
||||
`<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>`
|
||||
|
||||
11. Commit your changes using git add *, git commit -m "Language translation: your-language translation" and git push.
|
||||
12. Open your repository in a browser and click on "Contribute"
|
||||
|
||||
|
||||
|
||||
14. Answer all the questions, and in the "Type of Change" section, add `- [x] Translation support`
|
||||
15. Create a pull request 🎉
|
||||
113
docs/install/languages.md
Normal file
113
docs/install/languages.md
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
# Languages 🌍
|
||||
|
||||
## Default language
|
||||
|
||||
1. Open this file "client\src\store\language.js"
|
||||
2. modify the "default" in the lang variable with your ISO 3166 Alpha-2 code :
|
||||
|
||||
for example from english as default
|
||||
|
||||
```
|
||||
import { atom } from 'recoil';
|
||||
|
||||
const lang = atom({
|
||||
key: 'lang',
|
||||
default: 'en',
|
||||
});
|
||||
|
||||
export default { lang };
|
||||
```
|
||||
|
||||
to italian as dafult
|
||||
|
||||
```
|
||||
import { atom } from 'recoil';
|
||||
|
||||
const lang = atom({
|
||||
key: 'lang',
|
||||
default: 'it',
|
||||
});
|
||||
|
||||
export default { lang };
|
||||
```
|
||||
|
||||
# How to add a translation to LibreChat
|
||||
|
||||
### Minimum Requirements:
|
||||
|
||||
1. Good knowledge of the language (some terms may undergo significant changes during translation)
|
||||
2. An editor, which can be Notepad or (**recommended**: [VSCode](https://code.visualstudio.com/download))
|
||||
|
||||
### Language translation
|
||||
|
||||
|
||||
1. Fork the LibreChat repository and download it using git clone https://github.com/danny-avila/LibreChat
|
||||
2. Navigate to the "client\src\localization" folder and open the "Translation.tsx" file
|
||||
3. At the beginning of the code, add your language below all the others in this format:
|
||||
|
||||
`import Language-name from './languages/** ';`
|
||||
|
||||
For example, let's take English as an example:
|
||||
|
||||
Note: Replace "LanguageName" with the name of your language (capitalized) and "**" with the ISO 3166 Alpha-2 code of your country (the initial of the nation).
|
||||
If you don't know the ISO 3166 code for your language, check it [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) and also use it with an initial capital)
|
||||
|
||||
4. Further down in the code, add the following
|
||||
|
||||
`if (langCode === '**') return Language-name;`
|
||||
|
||||
Replace "**" with the ISO 3166 Alpha-2 code of your language (in lowercase). Here's an example: `if (langCode === 'en') return English;`)
|
||||
|
||||
7. Go into the "languages" folder and create a file named as follows: **.tsx
|
||||
|
||||
For example: En.tsx
|
||||
|
||||
9. Copy all the content from En.tsx into your file and modify it as follows:
|
||||
|
||||
```
|
||||
// your-language-name phrases
|
||||
|
||||
export default {
|
||||
com_ui_examples: 'Examples',
|
||||
// Add more translations here
|
||||
```
|
||||
|
||||
Rename only the part after the colon ":" to the corresponding translation in your language. For example:
|
||||
|
||||
```
|
||||
// my-language phrases
|
||||
|
||||
export default {
|
||||
com_ui_examples: 'WORD_THAT_I_TRANSLATE_IN_TO_MY_LANGUAGE',
|
||||
// Add more translations here
|
||||
};
|
||||
```
|
||||
|
||||
⚠️DO NOT CHANGE com_... ⚠️
|
||||
|
||||
10. To add your language to the menu, open the file "client\src\components\Nav\SettingsTabs\General.tsx" and add your language to the "LangSelector" variable in the following way:
|
||||
|
||||
```
|
||||
export const LangSelector = ({
|
||||
//other code
|
||||
<option value="en">{localize(lang, 'com_nav_lang_english')}</option>
|
||||
//other languages...
|
||||
<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
|
||||
</select>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
where ** is the ISO 3166 Alpha-2 code and "com_nav_lang_your-language-name" stands for the name in your language (for example com_nav_lang_english or com_nav_lang_italian)
|
||||
The only line of code to add is:
|
||||
|
||||
`<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>`
|
||||
|
||||
11. Commit your changes using git add *, git commit -m "Language translation: your-language translation" and git push.
|
||||
12. Open your repository in a browser and click on "Contribute"
|
||||
|
||||
|
||||
|
||||
14. Answer all the questions, and in the "Type of Change" section, add `- [x] Translation support`
|
||||
15. Create a pull request 🎉
|
||||
|
|
@ -91,6 +91,7 @@ nav:
|
|||
- APIs and Tokens: 'install/apis_and_tokens.md'
|
||||
- User Auth System: 'install/user_auth_system.md'
|
||||
- Online MongoDB Database: 'install/mongodb.md'
|
||||
- Languages: 'install/languages.md'
|
||||
- Features:
|
||||
- Plugins:
|
||||
- Introduction: 'features/plugins/introduction.md'
|
||||
|
|
@ -111,7 +112,7 @@ nav:
|
|||
- Contributions:
|
||||
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
|
||||
- Code Standards and Conventions: 'contributions/coding_conventions.md'
|
||||
- Testing: 'contributions/testing.md'
|
||||
- Testing: 'contributions/testing.md'
|
||||
|
||||
extra:
|
||||
social:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue