Simple Vagrant file to build a GitHub Pages-compatible Jekyll environment. Uses the "official" github-pages gem.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
Vagrantfile

README.md

Vagrant file for a GitHub Pages-compatible Jekyll environment

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.

How to use

First, make sure you've installed Vagrant and VirtualBox.

Next, clone this repo:

git clone git@github.com: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

Port forwarding

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.

Note on SSH-forwarding

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.