consul/website/README.md

22 lines
734 B
Markdown
Raw Normal View History

# Consul Website
2014-02-07 16:41:03 -08:00
2017-03-08 11:26:11 -08:00
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.
2014-02-07 16:41:03 -08:00
## Contributions Welcome!
2014-02-07 16:41:03 -08:00
If you find a typo or you feel like you can improve the HTML, CSS, or
2017-03-08 11:26:11 -08:00
JavaScript, we welcome contributions. Feel free to open issues or pull requests
like any normal GitHub project, and we'll merge it in.
2014-02-07 16:41:03 -08:00
## Running the Site Locally
2014-02-07 16:41:03 -08:00
2017-03-08 11:26:11 -08:00
Running the site locally is simple. Clone this repo and run `make website`.
2014-02-07 16:41:03 -08:00
2017-03-08 11:26:11 -08:00
Then open up `http://localhost:4567`. Note that some URLs you may need to append
".html" to make them work (in the navigation).
2014-09-02 09:20:37 -07:00
2017-03-08 11:26:11 -08:00
[middleman]: https://www.middlemanapp.com
[consul]: https://www.consul.io