Verdaccio website
Documentation
Documentation files are hosted under /docs
folder.
Install pnpm
globally
npm i -g pnpm
Running the website locally
You should run all these tasks from the inner /website
folder.
The commands you need to use for serving the site locally:
cd website/
- Move to website folder, it contains docusaurus source code.pnpm install
- Install all dependencies.pnpm run start
- Runs Verdaccio documentation site on http://localhost:3000/pnpm run build
- Build the website on build/ folder.
Running the website as a Docker container
The Verdaccio documentation website can run as a Docker container (useful for offline usage of the website).
In order to run the website on Docker, use the following commands (run commands from the outer /website folder):
docker build -t verdaccio-docs:4.0.1 .
- building the Verdaccio documentation site image
docker run -p <host-port>:3000 verdaccio-docs:4.0.1
- starting the container, listening on for your choice.
Saving the image for later offline usage is available by building the container and then using docker save verdaccio-docs:4.0.1 > <tar-name>.tar
and loading it afterwards with docker load < <tar-name>.tar
.
tested on ubuntu 18.04.2 with Docker 18.09.6
Translation
Verdaccio is powered by crowdin platform that provides Verdaccio a free open source license.
How to help with translations
- Create an account at Crowdin https://crowdin.com/project/verdaccio (It is free)
- Choose your language
- Choose a file
- Suggest a translation
Crowdin works with 2 sort of roles, Translator and Proofreader. All users are Translator by default. Any suggestion should be approved by a proofreader for each language.
If you want to be a Proofreader send me a private message over crowdin.
If you are willing to translate and language is not available, feel free to requested with a ticket.
Privates messages here https://crowdin.com/profile/juanpicado
Search Algolia configuration
Can be modified here: https://github.com/algolia/docsearch-configs/blob/master/configs/verdaccio.json
Translation stats the last year
Special Thanks
Thanks to the following companies to help us to achieve our goals providing free open source licenses.
Contributing
Read the contribution guidelines before start.