vagrant/website/README.md

31 lines
778 B
Markdown
Raw Normal View History

2016-10-29 20:49:57 +00:00
# Vagrant Website
2013-09-03 20:48:55 +00:00
2016-10-29 20:49:57 +00:00
This subdirectory contains the entire source for the [Vagrant Website](https://www.vagrantup.com/).
This is a [Middleman](http://middlemanapp.com) 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
JavaScript, we welcome contributions. Feel free to open issues or pull
2016-10-29 20:49:57 +00:00
requests like any normal GitHub project, and we'll merge it in.
2013-09-03 20:48:55 +00:00
## Running the Site Locally
2016-10-29 20:49:57 +00:00
To run the site locally, clone this repository and run:
```shell
$ make website
```
You must have Docker installed for this to work.
Alternatively, you can manually run the website like this:
```shell
$ bundle
$ bundle exec middleman server
```
2013-09-03 20:48:55 +00:00
2016-10-29 20:49:57 +00:00
Then open up `http://localhost:4567`.