2014-04-17 14:08:52 +00:00
|
|
|
# Consul Website
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-17 14:08:52 +00:00
|
|
|
This subdirectory contains the entire source for the [Consul Website](http://www.consul.io).
|
2014-02-08 00:41:03 +00:00
|
|
|
This is a [Middleman](http://middlemanapp.com) project, which builds a static
|
|
|
|
|
site from these source files.
|
|
|
|
|
|
|
|
|
|
## Contributions Welcome!
|
|
|
|
|
|
|
|
|
|
If you find a typo or you feel like you can improve the HTML, CSS, or
|
|
|
|
|
JavaScript, we welcome contributions. Feel free to open issues or pull
|
|
|
|
|
requests like any normal GitHub project, and we'll merge it in.
|
|
|
|
|
|
|
|
|
|
## Running the Site Locally
|
|
|
|
|
|
|
|
|
|
Running the site locally is simple. Clone this repo and run the following
|
|
|
|
|
commands:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ bundle
|
|
|
|
|
$ bundle exec middleman server
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then open up `localhost:4567`. Note that some URLs you may need to append
|
|
|
|
|
".html" to make them work (in the navigation and such).
|
