inspec/www/README.md
2016-09-23 15:27:34 +02:00

44 lines
774 B
Markdown

# InSpec homepage
## Development
Get all dependencies:
```bash
bundle install
```
To run it live run:
```bash
bundle exec middleman server
```
For the online tutorial, take a look at `www/tutorial`.
## Building
To build the site to a local static folder (without tutorial):
```bash
bundle exec middleman build
```
To build everything including the online tutorial:
```
bundle exec rake www:build
```
## Releasing
To push a new version of the website, make sure that you have built the site
(see previous section) and that you are happy with the results. If so, run:
```
bundle exec rake www:release
```
It will clear and create a local `gh-pages` branch, add the site to it,
and ask you before it pushes everything to `origin/gh-pages` i.e. the live
website.