1# Consul Website
2
3This subdirectory contains the entire source for the [Consul Website][consul].
4This is a [Middleman][middleman] project, which builds a static site from these
5source files.
6
7## Contributions Welcome!
8
9If you find a typo or you feel like you can improve the HTML, CSS, or
10JavaScript, we welcome contributions. Feel free to open issues or pull requests
11like any normal GitHub project, and we'll merge it in.
12
13## Running the Site Locally
14
15Running the site locally is simple. Clone this repo and run `make website`.
16
17Then open up `http://localhost:4567`. Note that some URLs you may need to append
18".html" to make them work (in the navigation).
19
20[middleman]: https://www.middlemanapp.com
21[consul]: https://www.consul.io
22