Minimal Mistakes, a Jekyll Theme

Minimal Mistakes, a Jekyll Theme

Jekyll is pretty rad and figured releasing an older version of my site as a theme for others to hack and build on would be fun. So here be that theme — I call it Minimal Mistakes, a responsive Jekyll theme focused on great typography for text heavy sites.

Update: Minimal Mistakes makes use of Sass and data files as part of Jekyll 2.x. Updating your site’s look and feel just got easier!

Features

  • Responsive layouts. Looks good on mobile, tablets, and desktop devices.
  • Full compatibility with GitHub Pages.
  • Minimal design.
  • Author sidebar with optional links to social media profiles.
  • Support for large images to call out your favorite posts.
  • Tags for Open Graph and Twitter Cards for a better social sharing experience.
  • Stylesheets for Pygments and Coderay syntax highlighting.
Screenshot of Minimal Mistakes theme

Installation

Minimal Mistakes now requires Jekyll 2.x. Make sure to run gem update jekyll if you aren’t on the latest version or gem install jekyll if this is your first time installing it.

If you are creating a new Jekyll site using Minimal Mistakes follow these steps:

  1. Fork the Minimal Mistakes repo.
  2. Clone the repo you just forked and rename it.
  3. Install Bundler gem install bundler and Run bundle install to install all dependencies (Jekyll, Jekyll-Sitemap, Octopress, Bourbon, etc)
  4. Update config.yml, add navigation, and replace demo posts and pages with your own. Full details here.

If you want to use Minimal Mistakes with an existing Jekyll site follow these steps:

  1. Download Minimal Mistakes and unzip.
  2. Rename minimal-mistakes-master to something meaningful ie: new-site
  3. Run bundle install to install all dependencies (Jekyll, Jekyll-Sitemap, Octopress, Bourbon, etc)
  4. Remove demo posts and pages add replace with your own posts, pages, and any other content you want to move over.
  5. Update posts and pages YAML to match variables used by Minimal Mistakes.
  6. Update config.yml and add navigation links. Full details here.

ProTip: Delete the gh-pages branch after cloning and start fresh by branching off master. There is a bunch of garbage in gh-pages used for the theme’s demo site that I’m guessing you won’t want.


Usage

To learn more about how to customize this theme, include feature images in posts, modify the look and feel, create new posts, and some other junk, read up here.

Questions?

Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter @mmistakes or file a GitHub issue. And if you make something cool with this theme feel free to let me know.

License

This theme is free and open source software, distributed under the MIT License. So feel free to modify it however you’d like without linking back to me or including a disclaimer.


Michael Rose

Written by

Just another boring, tattooed, time traveling designer from Buffalo.

Updated