vagrant/website/README.md

24 lines
877 B
Markdown
Raw Permalink Normal View History

2016-10-29 20:49:57 +00:00
# Vagrant Website
2013-09-03 20:48:55 +00:00
2017-03-08 19:32:17 +00:00
This subdirectory contains the entire source for the [Vagrant Website][vagrant].
This is a [Middleman][middleman] project, which builds a static site from these
source files.
2013-09-03 20:48:55 +00:00
## Contributions Welcome!
If you find a typo or you feel like you can improve the HTML, CSS, or
2017-03-08 19:32:17 +00:00
JavaScript, we welcome contributions. Feel free to open issues or pull requests
like any normal GitHub project, and we'll merge it in.
2013-09-03 20:48:55 +00:00
See also the [Vagrant Contributing Guide](https://github.com/hashicorp/vagrant/blob/master/.github/CONTRIBUTING.md) for more details.
2013-09-03 20:48:55 +00:00
## Running the Site Locally
2017-03-08 19:32:17 +00:00
Running the site locally is simple. Clone this repo and run `make website`.
2016-10-29 20:49:57 +00:00
2017-03-08 19:32:17 +00: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-29 20:49:57 +00:00
2017-03-08 19:32:17 +00:00
[middleman]: https://www.middlemanapp.com
[vagrant]: https://www.vagrantup.com