Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: update on default language and how to add a language 🌐 (#1042)

Browse source 
* Update translation_contribution.md

* fix(language) update to the new Locale Identifier

* Update translation_contribution.md

* Update default_language.md

* Update translation_contribution.md

* Update default_language.md

* Update translation_contribution.md
This commit is contained in:
Marco Beretta 2023-10-11 22:37:42 +02:00 • committed by GitHub
parent f63fe4b4e0
commit bc7a079208
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
client/src/store/language.ts
View file

@ -2,7 +2,7 @@ import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: localStorage.getItem('lang') || 'en',
default: localStorage.getItem('lang') || 'en-US',
});
export default { lang };

20
docs/contributions/translation_contribution.md
View file

@ -16,16 +16,18 @@ Fork the [LibreChat repository](https://github.com/danny-avila/LibreChat) and do
- At the beginning of the code, add your language below all the others in this format:
`import Language-name from './languages/** ';`
Example (English):`import English from './languages/Eng';`
- Further down in the code, add the following:
- Further down in the code, add in the language mapping, the following:
`if (langCode === '**') return Language-name;`
`'**-**': LanguageName,`
>Replace "**" with the ISO 3166 Alpha-2 code of your language (in lowercase).
Example (English): `if (langCode === 'en') return English;`
> Replace `**-**` with the local identifier of your language (ask ChatGPT or search it on Google).
>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)
> Replace `LanguageName` with the name of your language.
Example (English): `'en-US': English,`
### Create your new language file
- Go into the `client\src\localization\languages` folder and create a file named as follows: `**.tsx`
@ -56,7 +58,7 @@ Example (English): `if (langCode === 'en') return English;`
⚠️ Do not modify the `com_...` part ⚠️
> Delete the Language list after `com_nav_setting_general: 'General',` near the bottom of the file (You do not need to translate the individual language names)
### Delete the Language list after `com_nav_setting_general: 'General',` near the bottom of the file (You do not need to translate the individual language names), except for `com_nav_setting_data: 'Data controls'` (you need to translate it)
### Add your language to `Eng.tsx`
@ -69,7 +71,7 @@ Add your language to the `LangSelector` variable in the following way:
```js
export const LangSelector = ({
//other code
<option value="en">{localize(lang, 'com_nav_lang_english')}</option>
<option value="en-US">{localize(lang, 'com_nav_lang_english')}</option>
//other languages...
<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
</select>
@ -78,12 +80,12 @@ export const LangSelector = ({
};
```
Where `**` is the ISO 3166 Alpha-2 code and `com_nav_lang_your-language-name` stands for the name of your language.
Where `**-**` is the local identifier of your language and `com_nav_lang_your-language-name` stands for the name of your language.
Example: `com_nav_lang_english` or `com_nav_lang_italian`
**You should only need to add one line of code:**
```js
<option value="**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
<option value="**-**">{localize(lang, 'com_nav_lang_your-language-name')}</option>
```
### Summary

8
docs/install/default_language.md
View file

@ -2,8 +2,8 @@
## How to change the default language
- Open this file `client\src\store\language.js`
- Modify the "default" in the lang variable with your ISO 3166 Alpha-2 code :
- Open this file `client\src\store\language.ts`
- Modify the "default" in the lang variable with your locale identifier :
Example:
from **English** as default
@ -13,7 +13,7 @@ import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'en',
default: localStorage.getItem('lang') || 'en-US',
});
export default { lang };
@ -26,7 +26,7 @@ import { atom } from 'recoil';
const lang = atom({
key: 'lang',
default: 'it',
default: localStorage.getItem('lang') || 'it-IT',
});
export default { lang };