Skip to content

dkarski/minimal-resume-theme

Repository files navigation

Minimal Resume Theme

Introduction

This is a responsive minimal résumé template made by Daniel Karski, powered by Gatsby.js.

You may config all the data in json 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
  • Responsive template
  • PDF supports and print friendly
  • Font preloads
  • Offline mode
  • sitemap.xml & robots.txt generation
  • Flexible and extensible

Usage

Local Mode

  1. Clone the repo

    git clone https://dkarski.github.io/minimal-resume-theme/
  2. Install Jekyll

    npm install
  3. Config your résumé data

    The homepage is required in package.json if you serve this page on GitHub Pages. And your contact information, EDUCATION, SKILLS, EXPERIENCE, and PROJECTS data will be set in src/data/resume.json.

  4. Run and Debug

    npm start
  5. Build

    npm build

    ⚠️ before build make sure that https://dkarski.github.io/minimal-resume-theme/ is replaced in the whole project to correct address

  6. Deploy on GitHub Pages

    npm deploy

Extending Sections

  1. Add new section in src/data/resume.json
{
  "summary": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
}
  1. Add section to src/App.js:
import React from 'react';

const Summary = ({ summary }) => {
  const {
    dataJson: { summary },
  } = useStaticQuery(query)
  
  return (
    <div>
      <h1>Summary</h1>
      <p>{summary}</p>
    </div>
  );
};

export default Summary

export const query = graphql`
  query {
    dataJson {
      summary
    }
  }
`
import React from 'react';

const App = () => {
  return (
    <Summary />
  );
}

Showcases

Feel free to add yours here.

Donation

License

License: MIT