Skip to content

crispgm/resume

Repository files navigation

Crisp Minimal Résumé

GitHub CI Gem Version npm version

Introduction

English 简体中文

This is a responsive minimal résumé template made by Crisp, powered by Jekyll. And we also provide an official Hexo port 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

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

    git clone https://github.com/crispgm/resume.git
  2. Install Jekyll

    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

    jekyll serve
  5. Build

    jekyll build

Gem-based Theme

  1. Create a Gemfile

    source "https://rubygems.org"
    
    gem "jekyll-theme-minimal-resume"

    And then,

    bundle install
  2. Init _config.yml

    title: Résumé Title
    baseurl: "/resume/"
    theme: "jekyll-theme-minimal-resume"
  3. Create a index.html

    ---
    layout: resume
    ---
    
  4. Create _data/resume.yml and fill in your resume data. Example data is available here.

Data Format

Contact

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.

color: gray

Colors powered by Open-Color:

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

Colors powered by Nord:

  • nord

Extending Sections

  1. Add new section in _data/resume.yml

    languages:
      - name: English
        proficiency: Professional working proficiency
      - name: Mandarin Chinese
        proficiency: Native or bilingual proficiency
  2. Add section to _layouts/resume.html:

    <section id="languages">
      <div class="section-title">Language</div>
      <div class="section-content">
        {% for lang in site.data.resume.languages %}
        <div class="block">
          <div class="block-title">{{ lang.name }}</div>
          <div class="block-content">{{ lang.proficiency }}</div>
        </div>
        {% endfor %}
      </div>
    </section>

Showcases

Feel free to add yours here.

Donation

License

license