This repository contains the code for my resume site, built with Jekyll, a static site generator that transforms Markdown files into a clean, maintainable webpage. By using Markdown, the resume is lightweight, easy to update, and focused on content rather than styling. Minima is used as the default theme, providing a simple and minimalist design with basic styling. The resume is based on the template from markdownresume.app, as it provides a professional looking and ATS-friendly design in markdown.
The site is hosted on GitHub Pages, which offers an easy integration with Jekyll, and deploys from a branch. This out of the box deployment only supports version 2.5.1 of Minima. The jekyll workflow does support version 3 of Minima.
To export the resume as a PDF file press Crtl + P in any browser. Styling of the exported document is determined by the print.css file.
When the resume in index.md is updated the spelling is checked by the spelling_check workflow which uses PySpelling. The wordlist holds a list of words that are ignored during the spellcheck process.
A local development environment is important because to see the final site with Jekyll and Minima, there is no need to constantly push to the repository and wait for GitHub Pages to build and deploy the resume. Github provides a guide on how to do this, but it requires the installation of Jekyll, Ruby and Bundler. Instead this repository allows local devlopment with only Docker. So, make sure you have Docker running in the background, whether via the docker engine or Docker Desktop, and have Git installed to clone this repository.
- Clone the repository.
git clone https://github.com/dirkzon/resume.git- Cd into the repo.
cd resume- Run the
docker-compose.ymlfile. It could take a little bit before it starts up.
docker compose up- Visit the site on localhost:4000.
The index.md markdown file which holds the resume reloads automatically on saving, only the browser must be refreshed. The _config.yaml file does not automatically reload, but can be reloaded by restarting the docker container: docker compose restart jekyll.
- Stop the docker container.
docker compose down