open-consul/website
Kyle Havlovitz 5be21e3e24 Merge pull request #2726 from hashicorp/f-cli-rework-3
Centralize command-line parsing part 3
2017-02-10 13:42:01 -05:00
..
scripts
source
Gemfile
Gemfile.lock
LICENSE.md
Makefile
README.md
config.rb
config.ru
packer.json

README.md

Consul Website

This subdirectory contains the entire source for the Consul Website. This is a 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

To run the site locally, clone this repository and run:

$ make website

You must have Docker installed for this to work.

Alternatively, you can manually run the website like this:

$ bundle
$ bundle exec middleman server

Then open up http://localhost:4567.