packer-cn/website/README.md

23 lines
798 B
Markdown
Raw Normal View History

2017-03-08 14:32:46 -05:00
# Packer Website
2013-06-08 01:41:02 -04:00
2017-03-08 14:22:54 -05:00
This subdirectory contains the entire source for the [Packer Website][packer].
This is a [Middleman][middleman] project, which builds a static site from these
source files.
2013-06-08 01:41:02 -04:00
## Contributions Welcome!
If you find a typo or you feel like you can improve the HTML, CSS, or
2017-03-08 14:22:54 -05: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-06-08 01:41:02 -04:00
## Running the Site Locally
2017-05-09 14:41:06 -04:00
1. Install [Docker](https://docs.docker.com/engine/installation/) if you have not already done so
2. Clone this repo and run `make website`
2013-06-08 01:41:02 -04:00
2017-03-08 14:22:54 -05:00
Then open up `http://localhost:4567`. Note that some URLs you may need to append
".html" to make them work (in the navigation).
2013-06-08 01:41:02 -04:00
2017-03-08 14:22:54 -05:00
[middleman]: https://www.middlemanapp.com
2017-03-08 14:32:46 -05:00
[packer]: https://www.packer.io