open-consul/website/README.md
2017-03-08 11:26:11 -08:00

22 lines
734 B
Markdown

# Consul Website
This subdirectory contains the entire source for the [Consul Website][consul].
This is a [Middleman][middleman] 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 `make website`.
Then open up `http://localhost:4567`. Note that some URLs you may need to append
".html" to make them work (in the navigation).
[middleman]: https://www.middlemanapp.com
[consul]: https://www.consul.io