Creating a Jekyll resume with a theme

Introduction

In this tutorial you will learn how to create a jekyll website with a theme that is not the standard. In this example you will be creating a resume website. This method should work for most themes you find but you should always consult the documentation that they provide on how to set it up. For example Chirpy has one that you can either set up yourself or clone their repo and get it working that way.

Getting the files

First we need the theme. For this we will be using online-cv. You can clone the repo below to get the files, though you should fork it first. Forking just adds it to your account so when you make changes it goes to your repo and it is all your own.

git clone git@github.com:sharu725/online-cv.git

Creating the Gemfile

Now we need to create the Gemfile. This is what tells jekyll what gems to install during building of the site. This file will be in the folder you just cloned. Then copy the contents below to the file.

source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
#     bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "~> 4.2.0"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
# group :jekyll_plugins do
#   gem "jekyll-feed", "~> 0.12"
# end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
  gem "tzinfo", "~> 1.2"
  gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

Updating with your information

Next comes the personal touches. This is where you will edit the files with your information. They are all pretty straight forward. If you do not have information for that section, you can just comment it out or delete it. These are the main places you will want to edit: /_data/data.yml, CNAME, _config.yml, favicon.ico, and assets

Viewing your site

When you have finished editing the information and want to make sure that it all looks correct. You can run a docker container that will show you what your website will look like. You can also keep this up as it will update your site with any changes that you make.

docker run --rm -p 8080:4000 -v $(pwd):/site bretfisher/jekyll-serve