README.md

# xxDK Dev Docs

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Prerequisites
- [Node.js](https://nodejs.org/en/download/) version >= 14 or above OR [Yarn](https://yarnpkg.com/en/) version >= 1.5

## Project Structure

See [Project structure](https://docusaurus.io/docs/installation#project-structure)

## Installation
To install dependencies: 

```
$ npm install 
// or `yarn install`
```

## Local Development

```
cd my-website
npm run start 
# or `yarn 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.

## Build

```
$ npm run build
# or `yarn run build`
```

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

## Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

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

## Updating Docusaurus

See [Updating your Docusaurus version](https://docusaurus.io/docs/installation#updating-your-docusaurus-version)