Repository files navigation

This website is built usingDocusaurus 2, a modern static website generator.

The site is built throughnode andnpm (included in Node.js), and the minimum version required for it to work is:

"node": ">=16.14"

You can check your version by going to your terminal and performing:

node -v

Depending on your OS and your OS apps/package managers, you could find different methods of having the propernode version installed. Please visit theNode.js website to see thebest way for you to have it available in your system.

We recommend the use of a tool likeNVM which could ease the installation, and will also allow you to have differentnode versions coexisting in your system in case you need it. Using a LTS Node.js version is recommended.

$ npm install

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ npm run build

This command generates static content into thebuild directory and can be served using any static contents hosting service.

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to thegh-pages branch.