mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-16 21:56:25 -05:00
97 lines
5.9 KiB
Markdown
97 lines
5.9 KiB
Markdown
|
|
||
|
|
|
||
|
|
# @verdaccio/ui-theme
|
||
|
|
|
||
|
|
[Verdaccio](https://verdaccio.org/) UI is a [theme plugin](https://verdaccio.org/docs/en/dev-plugins#theme-plugin) build in React, Typescript and Emotion. It uses Jest and Testing Library for Unit testing.
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
||
|
|
[](https://verdaccio.org/docs/en/docker.html)
|
||
|
|
[](https://opencollective.com/verdaccio)
|
||
|
|
[](https://stackshare.io/verdaccio)
|
||
|
|
[](http://chat.verdaccio.org/)
|
||
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
||
|
|
[](./LICENSE)
|
||
|
|
[](https://crowdin.com/project/verdaccio)
|
||
|
|
[](https://codecov.io/gh/verdaccio/ui)
|
||
|
|
|
||
|
|
[](https://twitter.com/verdaccio_npm)
|
||
|
|
[](https://github.com/verdaccio/verdaccio/stargazers)
|
||
|
|
|
||
|
|
## Special Thanks
|
||
|
|
|
||
|
|
Thanks to the following companies to help us to achieve our goals providing free open source licenses.
|
||
|
|
|
||
|
|
[](https://www.jetbrains.com/)
|
||
|
|
[](https://crowdin.com/)
|
||
|
|
[](https://www.browserstack.com/)
|
||
|
|
|
||
|
|
## Open Collective Sponsors
|
||
|
|
|
||
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]
|
||
|
|
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/0/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/1/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/2/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/3/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/4/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/5/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/6/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/7/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/8/website)
|
||
|
|
[](https://opencollective.com/verdaccio/sponsor/9/website)
|
||
|
|
|
||
|
|
## Open Collective Backers
|
||
|
|
|
||
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)]
|
||
|
|
|
||
|
|
[](https://opencollective.com/verdaccio#backers)
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
|
||
|
|
This project exists thanks to all the people who contribute.
|
||
|
|
|
||
|
|
[](../../graphs/contributors)
|
||
|
|
|
||
|
|
### FAQ / Contact / Troubleshoot
|
||
|
|
|
||
|
|
If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.
|
||
|
|
|
||
|
|
- [Blog](https://medium.com/verdaccio)
|
||
|
|
- [Donations](https://opencollective.com/verdaccio)
|
||
|
|
- [Roadmaps](https://github.com/verdaccio/ui/projects)
|
||
|
|
- [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
|
||
|
|
- [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)
|
||
|
|
- [Chat](http://chat.verdaccio.org/)
|
||
|
|
- [Logos](https://verdaccio.org/docs/en/logo)
|
||
|
|
- [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
|
||
|
|
- [Docker Examples](https://github.com/verdaccio/docker-examples)
|
||
|
|
|
||
|
|
### Translations
|
||
|
|
|
||
|
|
Translations are handled locally. I18n files can be found in the folder `i18n/translations/*` of this repository. We would love to provide translations from other languages, embracing all our users, but unfortunately we cannot do this without your help. Would you like to help us? Please feel **super welcome** to add a locale by opening a pull request.
|
||
|
|
|
||
|
|
Your PR should contain:
|
||
|
|
|
||
|
|
1 - A json file in the folder `i18n/translations/*` with the translations. The file must be named according to the new added language
|
||
|
|
|
||
|
|
2 - The files `i18n/config.ts` and `LanguageSwitch.tsx` updated with the new language. Please see the current structure
|
||
|
|
|
||
|
|
3 - The other translations containing the new language in the language of the file. Example:
|
||
|
|
|
||
|
|
New language: `cs_CZ `
|
||
|
|
|
||
|
|
The file `pt-BR ` should contain:
|
||
|
|
|
||
|
|
```
|
||
|
|
"lng": {
|
||
|
|
...,
|
||
|
|
"czech": "Tcheco"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
4 - A SVG flag of the new translated language in the the folder `src/components/Icon/img/*`. You maybe want to compress the svg file using https://jakearchibald.github.io/svgomg/
|
||
|
|
|
||
|
|
### License
|
||
|
|
|
||
|
|
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|