README.md 929 Bytes
Newer Older
Tobias Schmidt's avatar
Tobias Schmidt committed
1
# Prometheus Documentation [![Build Status](https://travis-ci.org/prometheus/docs.svg?branch=master)](https://travis-ci.org/prometheus/docs)
2 3 4 5 6 7 8 9 10

This repository contains both the content and the static-site generator code for the
Prometheus documentation site.

## Prerequisites

You need to have a working Ruby environment set up and then install the
necessary gems:

11 12 13 14
```bash
cd docs
bundle
```
15 16 17 18 19

## Building

To generate the static site, run:

20 21 22
```bash
bundle exec nanoc
```
23 24 25 26 27 28 29

The resulting static site will be stored in the `output` directory.

## Development Server

To run a local server that displays the generated site, run:

30 31 32 33 34 35
```bash
# Rebuild the site whenever relevant files change:
bundle exec guard
# Start the local development server:
bundle exec nanoc view
```
36 37 38 39 40 41 42

You should now be able to view the generated site at
[http://localhost:3000/](http://localhost:3000).

## License

Apache License 2.0, see [LICENSE](LICENSE).