# jLight
## Table of contents

Getting Started
- [Documentation](#documentation)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Commands](#commands)

___

## Documentation

A markdown version of the documentation can be found [here](./docs/docs.md)

To view the HTML version you have to clone the repository since it is not hosted anywhere. It is located in `./docs/html`.

## Prerequisites

  * [Node](https://nodejs.org/)
  * [Yarn](https://yarnpkg.com/)

## Installing

```shell
  yarn
```

## Commands

```shell
  # Build project (development)
  yarn dev

  # Build project (production)
  yarn build

  # Watch js and css files
  yarn watch

  # Start dev server
  yarn serve

  # Generate documentation
  yarn docs
```
