-
Install Prerequisites (First Time Only)
- Ruby: Make sure Ruby is installed (version 2.5+)
- On Windows
- Use RubyInstaller
- Download the latest Ruby+Devkit version (2.5 or newer recommended)
- Run the installer and follow the prompts.
- On Mac
- Mac OS installer instructions for Jekyll
- Directly skip to 3.
- Bundler: Install bundler if not present:
gem install bundler
- Jekyll: You don’t need to install
jekyllglobally; GitHub Pages uses a Gemfile.
-
Install Project Dependencies
- In your project root directory:
This will install the correct Jekyll and plugin versions as specified in your
bundle install
Gemfile.
- In your project root directory:
-
Make Your Code Changes
- Edit files as needed (
_posts/,_layouts/,_includes/, assets, etc).
- Edit files as needed (
-
Serve the Site Locally
- In the project root, run:
bundle exec jekyll serve - Or, if your project uses the GitHub Pages Gem (common for gh-pages):
bundle exec jekyll serve --livereload - Visit http://localhost:4000 in your browser to view and test changes.
- In the project root, run:
-
Iterate
- Make further edits as needed. Jekyll will auto-reload changes (if using
--livereload).
- Make further edits as needed. Jekyll will auto-reload changes (if using
-
Commit and Push
- When satisfied:
git add . git commit -m "Describe your change" git push
- When satisfied:
-
Check GitHub Pages Deployment
- Visit your live site’s URL after GitHub Pages rebuilds your site (usually within a minute).
- If you get dependency errors, delete
Gemfile.lockand runbundle installagain. - For permission issues, try using
sudoor set up Ruby via a version manager (rbenvorrvm).
1-liner to install & serve
bundle install && bundle exec jekyll serveAgency theme based on Agency bootstrap theme
Portfolio projects are in /_posts
Images are in /img/portfolio
Images are in /img/about/
Team members and info are in _config.yml
Images are in /img/team/
View this jekyll theme in action here