https://github.com/sitewhere/sitewhere-documentation
Documentation generation for SiteWhere Projects
https://github.com/sitewhere/sitewhere-documentation
Last synced: 7 months ago
JSON representation
Documentation generation for SiteWhere Projects
- Host: GitHub
- URL: https://github.com/sitewhere/sitewhere-documentation
- Owner: sitewhere
- License: apache-2.0
- Created: 2017-06-04T13:20:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T12:46:11.000Z (over 3 years ago)
- Last Synced: 2024-04-13T23:54:35.944Z (about 2 years ago)
- Size: 34.5 MB
- Stars: 19
- Watchers: 11
- Forks: 48
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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/).