Quick-Start Guide

Minimal Mistakes has been developed as a Jekyll theme gem for easier use. It is also 100% compatible with GitHub Pages — just with a more involved installation process.

Installing the Theme

If you’re running Jekyll v3.3+ and self-hosting you can quickly install the theme as Ruby gem. If you’re hosting with GitHub Pages you’ll have to use the old “repo fork” method or directly copy all of the theme files¹ into your site.

ProTip: Be sure to remove /docs and /test if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don’t littering up in your repo.

Ruby Gem Method

Add this line to your Jekyll site’s Gemfile:

gem "minimal-mistakes-jekyll"

1. See Structure page for a list of theme files and what they do. ↩