Resume template

A simple Jekyll + GitHub Pages powered resume template.

Contents

• Requirements
• Running Locally
• Docker
• Basic Customization
• Editing Content Configuration
• Publishing to GitHub
• Configure with your domain name
• License

Requirements

1. Install ruby version 2.7.1 Ruby development environment
2. Install jekyll version 4.2.0 and the correct version of bundler with gem install bundler:2.2.2
3. Official Jekyll image include ruby 2.7.1 and bundler 2.2.2
4. Run bundle install to install all dependencies specified in the Gemfile
5. The application by default runs in port 4000

Running Locally

To test locally, run the following in your terminal:

1. Clone repo locally
2. cd to the project root folder
3. bundle install
4. bundle exec jekyll serve
5. Open your browser to localhost:4000

Basic Customization

Most of the basic customization will take place in the /_config.yml file. Here is a list of customizations available via /_config.yml:

[...write these out...]

Editing Content

Most of the content configuration will take place in the /_layouts/resume.html file. Simply edit the markup there accordingly

Publishing to Github

GitHub Pages will host this for free with your GitHub account.

Configuring with your own domain name

To setup your GH Pages site with a custom domain, follow the instructions on the GitHub Help site for that topic.

License

The code and styles are licensed under the MIT license. See project license. Obviously you should not use the content of this repo in your own resume. :wink: