README.md

vagrant-jekyllbox

Vagrant box aimed at bootstraping the work with jekyll and/or github pages. It supports live-reload regime by using jekyll-livereload plugin.

Getting Started

First of all you will need to install VirtualBox and vagrant.

Then:

cd ~
git clone https://github.com/infiRD/vagrant-jekyllbox.git
cd vagrant-jekyllbox
vagrant up && vagrant ssh

If you want to upgrade linux distribution in the box, run following:

UPGRADE=true vagrant up && vagrant reload && vagrant ssh

Working with jekyll projects

All project files should be placed in projects directory synchronized between host and VM. Here you should clone your repository containing jekyll project:

cd ~/projects
git clone <your repo URL>

In order to support live reload, it is neccesary to enable jekyll-livereload plugin inside project's Gemfile:

group :jekyll_plugins do
    gem 'jekyll-livereload'
end

It is neccesary to run bundle install:

bundle install

And only thing remaining is to run jekyll serve:

bundle exec jekyll serve --watch \
   --host 192.168.68.8 --port 4000 --force_polling \
   --livereload

Project will be accessible on http://192.168.68.8:4000

Default livereload port is 35729

Note: static IP address is neccesary for live reload plugin to inject the live-reload script correctly. It can be changed by editing Vagrantfile on the line:

config.vm.network "private_network", ip: "192.168.68.8"

Based on

• Ubuntu 16.04.1 LTS (Xenial Xerus) - Linux distro
• VAGRANT - VM manager
• jekyll - Static site generator
• Github Pages
• RobertDeRose/jekyll-livereload - jekyll live-reload plugin
• oh-my-zsh
• LS_COLORS

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository

Authors

• Martin Zamba - Initial work - infiRD

License

This project is licensed under the MIT License - see the LICENSE file for details

Contributing

Contributions are welcome. Just fork the GitHub repository and send a pull request