Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/byanko55/jekyll-professional-resume

A simple, modern, and professional resume template built for jekyll
https://github.com/byanko55/jekyll-professional-resume

blog-theme cv-template github-pages jekyll-theme personal-website

Last synced: 18 days ago
JSON representation

A simple, modern, and professional resume template built for jekyll

Host: GitHub
URL: https://github.com/byanko55/jekyll-professional-resume
Owner: byanko55
License: mit
Created: 2024-03-09T14:07:33.000Z (10 months ago)
Default Branch: master
Last Pushed: 2024-06-16T19:23:38.000Z (7 months ago)
Last Synced: 2024-12-06T15:20:14.150Z (30 days ago)
Topics: blog-theme, cv-template, github-pages, jekyll-theme, personal-website
Language: SCSS
Homepage: https://byanko55.github.io/resume-demo/
Size: 1.01 MB
Stars: 24
Watchers: 2
Forks: 61
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![CI](https://img.shields.io/badge/Github%20Pages-passing-gold.svg?logo=github)](ci)
[![License: MIT](https://img.shields.io/badge/License-MIT-orange.svg)](https://opensource.org/licenses/MIT)
[![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.9-green.svg)](https://jekyllrb.com/)
[![Jekyll](https://img.shields.io/badge/gem%20version-3.2.33-blue.svg)](gem)

# 🎓 - Jekyll Professional Resume

A simple and modern resume template, best fit for either **Academic CV (Curriculum Vitae)** or **Engineer Portfolio**.

Live demo is available [here](https://byanko55.github.io/resume-demo/).

![demo](https://i.ibb.co/HYshYc0/231232121.webp)

## Setup
Fork [this repository](https://github.com/byanko55/jekyll-professional-resume) or download the [source](https://github.com/byanko55/jekyll-professional-resume/releases) as a zip.

**Rename your repository as USERNAME.github.io or anything else.**

If you choose the former, then your URL will be https://USERNAME.github.io/.

Otherwise (let's say `myresume`), you need to edit the '*baseurl*' parameter in `_config.yml`. In this case, the resume page will be served to "https://USERNAME.github.io/myresume/".

```yml
# set baseurl as "/". ex) baseurl: /myresume
baseurl: myresume/
```

### Update Profile
In `_config.yml`, you can modify personal info such as your *photo, phone number, email*, and other social accounts.

```yml
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 protected]
linkedin_username: linkedin
github_username: github
...

```

### Create a Topic

All resume information should be placed in a directory named '`_data`'. You may need to manage personal data in separate groups, making a *Yaml* (`.yml`) file for each subject.

```
._data
├── SUBJECT1.yml
├── SUBJECT2.yml
├── SUBJECT3.yml
...

```

For instance,

```
._data
├── Awards.yml
├── Education.yml
├── Experience.yml
├── Languages.yml
├── Projects.yml
├── Publications.yml
├── Skills.yml
```

### Fill your infomation

Open the *Yaml* file which you created right before. Add the following materials inside of the file.

* **subject**: title of a subject
* **listing-order**: determines the display order (from top to bottom)
* **icon**: representative icon to be displayed (pick out from `resources/svgs`)
* **contents**: The details of each item, listed in `KEY`-`VALUE` pairs

```yml
subject:
listing-order:
icon:
contents:
- title: ITEM 1
KEY: VALUE
KEY: VALUE
...
- title: ITEM 2
KEY: VALUE
...
```

For a better understanding, see the example below.

```yml
subject: Education
listing-order: 1
icon: "/assets/img/graduation-cap.svg"
contents:
- title: Stanfort University, MA in Computer Science
description:
- Development of algorithms for tracking the facial expressions
- Optimizing parameter efficient fine tuning for fairness
grade: "**GPA**: `4.1/4.3`"
date: Mar. 2014 - Feb. 2016
...

```

The rendered output looks like this:

![example1](https://i.ibb.co/9TGKPrv/123312.webp)