opentofu/website/README.md

22 lines
749 B
Markdown
Raw Normal View History

2014-07-16 16:51:48 -05:00
# Terraform Website
2017-03-08 13:27:47 -06:00
This subdirectory contains the entire source for the [Terraform
Website][terraform]. This is a [Middleman][middleman] project, which builds a
static site from these source files.
2014-07-16 16:51:48 -05:00
2016-10-31 17:36:33 -05:00
## Contributions Welcome!
2014-07-16 16:51:48 -05:00
If you find a typo or you feel like you can improve the HTML, CSS, or
2017-03-08 13:27:47 -06: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-07-16 16:51:48 -05:00
## Running the Site Locally
2017-03-08 13:27:47 -06:00
Running the site locally is simple. Clone this repo and run `make website`.
2014-07-16 16:51:48 -05:00
2017-03-08 13:27:47 -06:00
Then open up `http://localhost:4567`. Note that some URLs you may need to append
".html" to make them work (in the navigation).
2016-10-31 17:36:33 -05:00
2017-03-08 13:27:47 -06:00
[middleman]: https://www.middlemanapp.com
[terraform]: https://www.terraform.io