Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/crispgm/resume

A minimalist resume template for Jekyll and Hexo
https://github.com/crispgm/resume

jekyll jekyll-theme jekyll-themes minimalist-template nord-theme resume-creator resume-template theme

Last synced: 28 days ago
JSON representation

A minimalist resume template for Jekyll and Hexo

Awesome Lists containing this project

README

        

# Crisp Minimal Résumé





GitHub CI

Gem Version


npm version

## Introduction

[English](/README.md) [简体中文](/README_zh-CN.md)

This is a responsive minimal résumé template made by Crisp, powered by [Jekyll](http://jekyllrb.com/). And we also provide an official [Hexo port](/port-hexo/README.md) for Hexo users.

You may config all the data in `yaml` and make it your own résumé. Then, you might use on GitHub Pages, your website, or wherever you want.

[DEMO](https://crispgm.github.io/resume/resume.html)

## Features

- Simple, elegant, and minimal design
- PC and mobile friendly, but it looks better on PC
- PDF supports and print friendly
- Flexible and extensible

## Usage

### Local Mode

1. Clone the repo

```shell
git clone https://github.com/crispgm/resume.git
```

2. Install Jekyll

```shell
gem install jekyll
```

3. Config your résumé data

The `baseurl` is required in `_config.yml` if you serve this page as part of your website. And your contact information, **EDUCATION**, **SKILLS**, **EXPERIENCE**, and **PROJECTS** data will be set in `_data/resume.yml`.

4. Run and Debug

```shell
jekyll serve
```

5. Build

```shell
jekyll build
```

### Gem-based Theme

1. Create a `Gemfile`

```shell
source "https://rubygems.org"

gem "jekyll-theme-minimal-resume"
```

And then,

```shell
bundle install
```

2. Init `_config.yml`

```yaml
title: Résumé Title
baseurl: "/resume/"
theme: "jekyll-theme-minimal-resume"
```

3. Create a `index.html`

```yaml
---
layout: resume
---

```

4. Create `_data/resume.yml` and fill in your resume data. [Example data is available here](/_data/resume.ytml).

## Data Format

### Contact

```yaml
contact:
- icon: fa-envelope
text: [email protected]
- icon: fa-phone-square
text: your-phone-num
- icon: fa-globe
text: your-website.com
link: https://crispgm.github.io/resume/resume.html
```

FontAwesome iconfont is embedded, so use the `fa-` class name as icon. `link` is optional, present if you want a link for your web version.

## Colors

There are a set of colorscheme. `color` may be specified in `_config.yml`. The default colorscheme is gray.

```yaml
color: gray
```

Colors powered by [Open-Color](https://yeun.github.io/open-color/):

- red
- pink
- grape
- violet
- indigo
- blue
- cyan
- teal
- green
- lime
- yellow
- orange

Colors powered by [Nord](https://www.nordtheme.com/):

- nord

## Extending Sections

1. Add new section in `_data/resume.yml`

```yaml
languages:
- name: English
proficiency: Professional working proficiency
- name: Mandarin Chinese
proficiency: Native or bilingual proficiency
```

2. Add section to `_layouts/resume.html`:

```html

Language


{% for lang in site.data.resume.languages %}

{{ lang.name }}

{{ lang.proficiency }}


{% endfor %}


```

## Showcases

Feel free to add yours here.

- [David Zhang](https://crispgm.com/resume/)

## Donation

- [Buy Me A Coffee](https://www.buymeacoffee.com/crispgm)

## License

[![license](https://img.shields.io/github/license/crispgm/resume.svg)](/LICENSE)