terraform/website/README.md

27 lines
973 B
Markdown
Raw Normal View History

2014-07-16 23:51:48 +02:00
# Terraform Website
This subdirectory contains the entire source for the [Terraform Website](http://www.terraform.io).
This is a [Middleman](http://middlemanapp.com) project, which builds a static
site from these source files.
2015-04-11 02:13:59 +02:00
## Contributions Welcome
2014-07-16 23:51:48 +02: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.
## Running the Site Locally
Running the site locally is simple. First you need a working copy of [Ruby >= 2.0](https://www.ruby-lang.org/en/downloads/) and [Bundler](http://bundler.io/).
Then you can clone this repo and run the following commands from this directory:
2014-07-16 23:51:48 +02:00
```
$ bundle
# ( installs all gem dependencies )
2014-07-16 23:51:48 +02:00
$ bundle exec middleman server
# ( boots the local server )
2014-07-16 23:51:48 +02:00
```
2014-08-06 14:51:33 +02:00
Then open up `http://localhost:4567`. Note that some URLs you may need to append
2014-08-06 14:36:20 +02:00
".html" to make them work (in the navigation).