diff --git a/website/README.md b/website/README.md index 0c6c2c2..6576b45 100644 --- a/website/README.md +++ b/website/README.md @@ -3,6 +3,15 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. ### Installation +Use `npm` or `yarn` to setup and test website on local environment. + +if you are using `npm`, then use below command to install all required dependencies. + +``` +$ npm install +``` + +If you are using `yarn`, use: ``` $ yarn @@ -10,6 +19,13 @@ $ yarn ### Local Development +To start a local development server, use: + +``` +$ npm run start +``` +or use: + ``` $ yarn start ``` @@ -18,6 +34,13 @@ This command starts a local development server and opens up a browser window. Mo ### Build +To generate static content for deployment, use: + +``` +$ npm run build +``` + or use: + ``` $ yarn build ``` @@ -28,6 +51,12 @@ This command generates static content into the `build` directory and can be serv Using SSH: +``` +$ USE_SSH=true npm run deploy +``` + +or use: + ``` $ USE_SSH=true yarn deploy ```