History

Matthew Hooker 8d5c316a30 docs/virtualbox: update skip_export wording		2017-01-10 15:24:10 -08:00
..
scripts	Update website push script to fix metadata	2016-04-12 20:12:15 +01:00
source	docs/virtualbox: update skip_export wording	2017-01-10 15:24:10 -08:00
Gemfile	Update middleman-hashicorp	2016-09-26 11:32:09 -05:00
Gemfile.lock	fix website build	2016-11-15 15:03:58 -08:00
Makefile	Added docker-dev target to run website in docker container	2016-12-28 22:04:10 +01:00
README.md	Docs cleanup	2015-07-22 17:18:08 -07:00
Vagrantfile	Updated Vagrantfile for testing docs	2016-12-28 21:47:36 +01:00
config.rb	Prep for release 0.12.1	2016-12-15 13:25:32 -08:00
config.ru	sidebar	2015-11-12 16:27:48 -08:00
packer.json	fix website build	2016-11-15 15:03:58 -08: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.