@verdaccio/ui-theme

What is @verdaccio/ui-theme?

@verdaccio/ui-theme is a theme package for Verdaccio, a lightweight private npm proxy registry. This package provides the user interface theme for Verdaccio, allowing users to customize and enhance the visual appearance of their Verdaccio instance.

What are @verdaccio/ui-theme's main functionalities?

Customizable UI Theme

This feature allows you to import and apply the Verdaccio UI theme to your Verdaccio instance. By importing the CSS file, you can customize the look and feel of your private npm registry.

import '@verdaccio/ui-theme/css/index.css';

Theme Configuration

This feature allows you to configure the theme settings for Verdaccio. You can specify different theme options such as 'dark' or 'light' to match your preferences.

const config = { theme: 'dark' };

Custom Logo

This feature allows you to set a custom logo for your Verdaccio instance. By specifying the path to your logo image, you can personalize the branding of your npm registry.

const config = { logo: '/path/to/logo.png' };

0

README

@verdaccio/ui-theme

Verdaccio UI is a theme plugin build in React, Typescript and Emotion. It uses Jest and Testing Library for Unit testing.

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

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]

Open Collective Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute.

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
• Donations
• Roadmaps
• Reporting an issue
• Running discussions
• Chat
• Logos
• FAQ
• 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