Installation from package.md

Build from Gem package

Prerequisites

Jekyll requires the following:

• Ruby version 2.5.0 or higher
• RubyGems
• GCC and Make

Install Jekyll & Bundler

gem install bundler jekyll

Create new jekyll site

jekyll new mysite

cd mysite
bundle config path 'vendor/bundle'

Update Gemfile & _config.yml

Replace the contents of Gemfile as follows:

source "https://rubygems.org"

gem "jekyll", "~> 3.9"
gem "jekyll-professional-resume", "~> 0.0.1"

group :jekyll_plugins do
  gem "jekyll-feed", "~> 0.12"
  gem "jekyll-sitemap", "~> 1.3", '< 1.4'
  gem "jekyll-seo-tag", "~> 2.6"
  gem "kramdown-parser-gfm", "~> 1.1.0"
  gem "webrick", "~> 1.7.0"
end

For _config.yml file,

title: Title of your CV site
profile_img: assets/img/profile.webp
icon_img: assets/img/icon.webp

name: "Your Name Here"
job: "〈Your Job Here〉"

phone_number: 012-345-6789
address: City, Country
email: email@example.com
linkedin_username: linkedin
github_username: github
instagram_username: instagram
twitter_username: twitter
facebook_username: facebook

theme: jekyll-professional-resume

exclude:
  - _posts/
  - resources/
  - vendor/

Run site locally

To test locally, run the following:

bundle install
bundle exec jekyll serve

Now open http://localhost:4000 in your browser.