github.com/richardmarshall/terraform@v0.9.5-0.20170429023105-15704cc6ee35/website/README.md (about)

     1  # Terraform Website
     2  
     3  This subdirectory contains the entire source for the [Terraform
     4  Website][terraform]. This is a [Middleman][middleman] project, which builds a
     5  static site from these source files.
     6  
     7  ## Contributions Welcome!
     8  
     9  If you find a typo or you feel like you can improve the HTML, CSS, or
    10  JavaScript, we welcome contributions. Feel free to open issues or pull requests
    11  like any normal GitHub project, and we'll merge it in.
    12  
    13  ## Running the Site Locally
    14  
    15  Running the site locally is simple. Clone this repo and run `make website`.
    16  
    17  Then open up `http://localhost:4567`. Note that some URLs you may need to append
    18  ".html" to make them work (in the navigation).
    19  
    20  [middleman]: https://www.middlemanapp.com
    21  [terraform]: https://www.terraform.io