Running Jekyll Locally

Quick guide that goes over installing and running Jekyll.

Table of Contents

• Setup
• How to use
• Helpful Links

Setup

• Install Ruby

sudo apt-get install ruby-full build-essential zlib1g-dev -y

• Setup Gem install dir to local user

echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

• Install Jekyll and Bundler

gem install jekyll bundler

How to use

• Navigate to the publishing directory of your Github pages repo.
• Build your site

bundle install

• Run the site instance

bundle exec jekyll serve

Helpful Links

• Setup Jekyll for local builds
• Create a new Jekyll project for github-pages

---

Written by James Immer