Simple Resume using GitHub Pages and Jekyll Theme Forked from Jglovier's Resume Template
To test locally make sure Ruby is installed, then run the following in your terminal:
- Clone repo locally
bundle install
bundle exec jekyll serve
- Open your browser to
localhost:4000
Protip: Using bundle exec jekyll serve --host 0.0.0.0
will make the website available for other devices on your network (so you can simply go to your PC's IP address from your mobile device - Example, Browse to http://192.168.0.69:4000)
To test locally with docker, run the following in your terminal after installing docker into your system:
docker image build -t resume .
docker run --rm --name resume -v "$PWD":/home/app --network host resume
First fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize (protip: press . on your repo's webpage).
Most of the basic customization will take place in the /_config.yml
file. Here is a list of customizations available via /_config.yml
:
- Title & Description
- (In Resume) Position Title, Avatar, Name, Email, Telephone, Address, Contact Info, Social Media Accounts
-
Most of the content configuration will take place in the
/_layouts/resume.html
file. Simply edit the markup there accordingly. -
To edit your resume content like education, associations etc, edit the
.yml
files in/_data
. -
To edit the styling of webpage, edit the
.scss
files in/_scss
. -
Change your avatar in
images/avatar.jpeg
.
GitHub Pages will host this for free with your GitHub account. After the setup, the site will be available at yourusername.github.io/resume
(you can rename the repo to resume for your own use if you want it to be available at yourusername.github.io/resume
). You can also add a CNAME if you want it to be available at a custom domain.
To setup your GH Pages site with a custom domain, follow the instructions on the GitHub Help site for that topic.
If you spot a bug, or want to improve the code, or even make the dummy content better, you can do the following:
- Open an issue describing the bug or feature idea
- Fork the project, make changes, and submit a pull request
The code and styles are licensed under the MIT license. See project license. Obviously you should not use the content of this demo repo in your own resume. ๐