# sitewhere-documentation

**Repository Path**: arohat/sitewhere-documentation

## Basic Information

- **Project Name**: sitewhere-documentation
- **Description**: Documentation generation for SiteWhere Projects
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SiteWhere Community Edition Documentation

This repository contains artifacts used to generate documentation for SiteWhere Community Edition.

## Build

In order to build the documentation you need to run the following command:

```sh
npm install
npm run docs:build
```

To run it in developer mode, execute the following command:

```sh
npm install
npm run docs:dev
```

Build OpenAPI Static Documentation

```sh
cd docs/.vuepress/public/api2/
wget -O sitewhere-api.json http://localhost:8080/sitewhere/api/v2/api-docs
redoc-cli bundle sitewhere-api.json --options.theme.colors.primary.main=#dc0000 -t sitewhere-docs.hbs
mv redoc-static.html index.html
```

Access the documentation at this [url](http://localhost:8080/).