History

Mark Peek 135a607fb4 Merge pull request #2745 from jessehub/master documentation - indent ami_block_device_mappings keys		2015-10-18 11:44:47 -07:00
..
source	Merge pull request #2745 from jessehub/master	2015-10-18 11:44:47 -07:00
.buildpacks	website: Set buildpacks to use middleman buildpack	2013-06-07 22:49:40 -07:00
.ruby-version	add note on EBS cleanup behavior	2015-06-19 16:06:09 -05:00
Gemfile	Docs cleanup	2015-07-22 17:18:08 -07:00
Gemfile.lock	Docs cleanup	2015-07-22 17:18:08 -07:00
Makefile	Change to 4 spaces	2015-07-22 20:25:58 -07:00
Procfile	Initial website commit	2013-06-07 22:41:02 -07:00
README.md	Docs cleanup	2015-07-22 17:18:08 -07:00
Vagrantfile	Updates to Into: Build An Image docs	2015-01-24 17:25:47 -06:00
config.rb	Docs cleanup	2015-07-22 17:18:08 -07:00
config.ru	Use Rack::Protection	2015-07-13 12:59:57 -04:00

README.md

Packer Website

This subdirectory contains the entire source for the Packer website. This is a Middleman project, which builds a static site from these source files.

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 requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. Clone this repo and run the following commands:

make dev

Then open up localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation and such).

Keeping Tidy

To keep the source code nicely formatted, there is a make format target. This runs htmlbeautify and pandoc to reformat the source code so it's nicely formatted.

make format

Note that you will need to install pandoc yourself. make format will skip it if you don't have it installed.