open-consul/website/README.md

32 lines
772 B
Markdown
Raw Normal View History

# Consul Website
2014-02-08 00:41:03 +00:00
This subdirectory contains the entire source for the
[Consul Website](https://www.consul.io/). This is a
[Middleman](http://middlemanapp.com) project, which builds a static site from
these source files.
2014-02-08 00:41:03 +00:00
## Contributions Welcome!
2014-02-08 00:41:03 +00:00
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.
2014-02-08 00:41:03 +00:00
## Running the Site Locally
2014-02-08 00:41:03 +00:00
To run the site locally, clone this repository and run:
2014-02-08 00:41:03 +00:00
```shell
$ make website
```
2014-09-02 16:20:37 +00:00
You must have Docker installed for this to work.
2014-09-02 16:20:37 +00:00
Alternatively, you can manually run the website like this:
2014-09-02 16:20:37 +00:00
```shell
2014-09-02 16:20:37 +00:00
$ bundle
$ bundle exec middleman server
2014-09-02 16:20:37 +00:00
```
Then open up `http://localhost:4567`.