Skip to content
Snippets Groups Projects
README.md 1.05 KiB
Newer Older
Jemimah Omodior's avatar
Jemimah Omodior committed
# xxDK Dev Docs

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

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

## Project Structure

Jemimah Omodior's avatar
Jemimah Omodior committed
See [Project structure](https://docusaurus.io/docs/installation#project-structure)
Jemimah Omodior's avatar
Jemimah Omodior committed

## Installation
To install dependencies: 
Jemimah Omodior's avatar
Jemimah Omodior committed
$ npm install 
// or `yarn install`
Jemimah Omodior's avatar
Jemimah Omodior committed
## Local Development
Jemimah Omodior's avatar
Jemimah Omodior committed
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.

Jemimah Omodior's avatar
Jemimah Omodior committed
## Build
Jemimah Omodior's avatar
Jemimah Omodior committed
$ 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.

Jemimah Omodior's avatar
Jemimah Omodior committed
## Deployment
Jemimah Omodior's avatar
Jemimah Omodior committed
See [Deployment](https://docusaurus.io/docs/deployment)
Jemimah Omodior's avatar
Jemimah Omodior committed

## Updating Docusaurus

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