0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
verdaccio/website
2021-07-21 07:55:18 +02:00
..
blog Update 2019-04-19-diving-into-jwt-support-for-verdaccio-4.md 2021-07-21 07:55:18 +02:00
core chore: add oss sponsor logo netlify 2021-07-11 16:51:02 +02:00
i18n docs(website): new cCrowdin updates (#2324) 2021-07-11 18:01:00 +02:00
pages/en chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00
static chore: update talk 2021-07-11 16:20:27 +02:00
translated_docs New Crowdin updates (#2325) 2021-07-11 18:39:26 +02:00
.gitignore chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00
Dockerfile chore: update readme 2021-07-11 17:06:52 +02:00
languages.js chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00
package.json chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00
README.md chore: update readme 2021-07-11 17:06:52 +02:00
sidebars.json chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00
siteConfig.js chore: relocate website for netlify migration (#2323) 2021-07-11 15:42:56 +02:00

Verdaccio website

backers discord MIT

https://www.verdaccio.org

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: source code.

  • 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

  1. Create an account at Crowdin https://crowdin.com/project/verdaccio (It is free)
  2. Choose your language
  3. Choose a file
  4. 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

screen shot 2019-02-22 at 6 58 54 am