CONTRIBUTING.md

Contributing to Verdaccio Website

Translations

If you are willing to contribute with translations you need to fullfil some requirements:

• You need a crowdin account.
• Chose the target language if exist otherwise request to be enabled.

Source Code Documentation

The language by default is English, all source code is under the docs folder.

https://github.com/verdaccio/website/tree/master/docs

Source Code Website

We use Docusaurus to publish the website, it is based on React. The source code is under the folder

https://github.com/verdaccio/website/tree/master/website

🚨🚨 Some caveats you need to keep on mind 🚨🚨:

• Do not update files in the following folders due are autogenerated by crowdin
  • website/website/translated_docs
  • website/website/versioned_docs
  • website/website/versioned_sidebars
  • website/i18n/!en.json (only update en.json, the other files are autogenerated)

Development

Running website locally

Go to cd website that include the docusaurus source code

Scripts

Start the dev server (browser will open)

yarn run start

Build the website on build/ folder

yarn run build