Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme file #360

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −0
Open

Update Readme file #360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,29 @@
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
```

### Local Development

To start a local development server, use:

```
$ npm run start
```
or use:

```
$ yarn start
```
Expand All @@ -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
```
Expand All @@ -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
```
Expand Down
Loading