Simple Vagrant file to build a GitHub Pages-compatible Jekyll environment. Uses the "official" github-pages gem. Use this environment to build and test your GitHub Pages-based Jekyll sites without polluting your host box.
First, make sure you've installed Vagrant and VirtualBox.
Next, clone this repo:
git clone [email protected]:rjsilk/vagrant-github-pages.git
Now, cd
into that directory and start up the Vagrant vm:
cd vagrant-github-pages
vagrant up
Finally, you can ssh into the vm and do all your Jekyll-related work in there:
vagrant ssh
The Vagrant vm is configured to forward port 8124 by default. So you can start a Jekyll server like so:
jekyll server --watch -P 8124
And then navigate to localhost:8124 on your host box.
The Vagrantfile enables ssh-forwarding so that you can use your host ssh keys to authenticate with github. Make sure to add you keys to the agent with ssh-add
before running vagrant ssh
if your keys aren't automatically added to the agent.