mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2025-11-17 15:45:14 +00:00
Tidy up
- Add help docs for most sections - Add translations documentation - Fix up todos - Remove german translation
This commit is contained in:
@@ -1,23 +1,48 @@
|
||||
# Internationalisation support
|
||||
|
||||
## Before you start
|
||||
|
||||
It's highly recommended that you spin up a development instance of this project
|
||||
on your docker capable server. It's pretty easy:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/NginxProxyManager/nginx-proxy-manager.git
|
||||
cd nginx-proxy-manager
|
||||
./scripts/start-dev -f
|
||||
```
|
||||
|
||||
Then after a while, you can access http://yourserverip:3081
|
||||
|
||||
This stack will watch the file system for changes, especially to language files,
|
||||
and reload the site you have open in the browser.
|
||||
|
||||
|
||||
## Adding new translations
|
||||
|
||||
Modify the files in the `src` folder. Follow the conventions already there.
|
||||
|
||||
When the development stack is running, it will sort the locale lang files
|
||||
for you when you save.
|
||||
|
||||
|
||||
## After making changes
|
||||
|
||||
You will need to run `yarn locale-compile` in this frontend folder for
|
||||
If you're NOT running the development stack, you will need to run
|
||||
`yarn locale-compile` in the `frontend` folder for
|
||||
the new translations to be compiled into the `lang` folder.
|
||||
|
||||
When running in dev mode, this should automatically happen within Vite.
|
||||
|
||||
## Adding a whole new language
|
||||
|
||||
There's a fair bit you'll need to touch. Here's a list that may
|
||||
not be complete by the time you're reading this:
|
||||
|
||||
- frontend/src/locale/src/[yourlang].json
|
||||
- frontend/src/locale/src/lang-list.json
|
||||
- frontend/src/locale/src/HelpDoc/*
|
||||
- frontend/src/locale/IntlProvider.tsx
|
||||
|
||||
|
||||
## Checking for missing translations in other languages
|
||||
## Checking for missing translations in languages
|
||||
|
||||
Run `node check-locales.cjs` in this frontend folder.
|
||||
|
||||
|
||||
## Adding new languages
|
||||
|
||||
todo
|
||||
|
||||
Reference in New Issue
Block a user