Repository files navigation

Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building personal sites, blogs, and portfolios. As the name implies, styling is purposely minimalistic to be enhanced and customized by you 😄.

✨ See what's new in theCHANGELOG.

Note: The theme uses thejekyll-include-cache plugin which will need to be installed in yourGemfile and must be retained in theplugins array of_config.yml. Otherwise you'll encounterUnknown tag 'include_cached' errors at build.

• Bundled as a "theme gem" for easier installation/upgrading.
• Compatible with GitHub Pages.
• Support for Jekyll's built-in Sass/SCSS preprocessor.
• Nine different skins (color variations).
• Several responsive layout options (single, archive index, search, splash, and paginated home page).
• Optimized for search engines with support forTwitter Cards andOpen Graph data.
• Optionalheader images,custom sidebars,table of contents,galleries, related posts,breadcrumb links,navigation lists, and more.
• Commenting support (powered byDisqus,Facebook, Google+,Discourse, static-based viaStaticman,utterances, andgiscus).
• Google Analytics support.
• UI localized text in English (default), Arabic (عربي), Brazilian Portuguese (Português brasileiro), Catalan, Chinese, Czech, Danish, Dutch, Finnish, French (Français), German (Deutsch), Greek, Hebrew, Hindi (हिंदी), Hungarian, Indonesian, Irish (Gaeilge), Italian (Italiano), Japanese, Kiswahili, Korean, Malayalam, Myanmar (Burmese), Nepali (Nepalese), Norwegian (Norsk), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Thai, Turkish (Türkçe), Ukrainian (Українська) and Vietnamese.

This theme comes in nine different skins (in addition to the default one).

air	contrast	dark

dirt	mint	sunrise

aqua	neon	plum

Additional sample posts are available underposts archive on the demo site. Source files for these (and the entire demo site) can be found in/docs.

There are three ways to install: as agem-based theme, as aremote theme (GitHub Pages compatible), or forking/directly copying all of the theme files into your project.

With Gem-based themes, directories such as theassets,_layouts,_includes, and_sass are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.

This allows for easier installation and updating as you don't have to manage any of the theme files. To install:

1. Add the following to yourGemfile:

   gem"minimal-mistakes-jekyll"

2. Fetch and update bundled gems by running the followingBundler command:

   bundle

3. Set thetheme in your project's Jekyll_config.yml file:

   theme:minimal-mistakes-jekyll

To update the theme runbundle update.

Remote themes are similar to Gem-based themes, but do not requireGemfile changes or whitelisting making them ideal for sites hosted with GitHub Pages.

To install:

1. Create/replace the contents of yourGemfile with the following:

   source"https://rubygems.org"gem"github-pages",group::jekyll_pluginsgem"jekyll-include-cache",group::jekyll_plugins

2. Addjekyll-include-cache to theplugins array of your_config.yml.

3. Fetch and update bundled gems by running the followingBundler command:

   bundle

4. Addremote_theme: "mmistakes/minimal-mistakes@4.26.2" to your_config.yml file. Remove any othertheme: orremote_theme: entry.

Looking for an example? Use theMinimal Mistakes remote theme starter for the quickest method of getting a GitHub Pages hosted site up and running. Generate a new repository from the starter, replace sample content with your own, and configure as needed.

For detailed instructions on how to configure, customize, add/migrate content, and more read thetheme's documentation.

Found a typo in the documentation or interested infixing a bug? Then by all meanssubmit an issue orpull request. If this is your first pull request, it may be helpful to read up on theGitHub Flow first.

For help with using the theme or general Jekyll support questions, please use theJekyll Talk forums.

When submitting a pull request:

1. Clone the repo.
2. Create a branch off ofmaster and give it a meaningful name (e.g.my-awesome-new-feature).
3. Open a pull request on GitHub and describe the feature or fix.

Theme documentation and demo pages can be found in the/docs if submitting improvements, typo corrections, etc.

To set up your environment to develop this theme, runbundle install.

To test the theme, runbundle exec rake preview and open your browser athttp://localhost:4000/test/. This starts a Jekyll server using content in thetest/ directory. As modifications are made to the theme and test site, it will regenerate and you should see the changes in the browser after a refresh.

Michael Rose

• https://mademistakes.com
• https://twitter.com/mmistakes
• https://github.com/mmistakes

• The Noun Project - Garrett Knoll, Arthur Shlain, andtracy tam
• Font Awesome
• Unsplash

• Jekyll
• jQuery
• Susy
• Breakpoint
• Magnific Popup
• FitVids.JS
• GreedyNav.js
• Smooth Scroll
• Gumshoe
• jQuery throttle / debounce
• Lunr
• Clipboard.js

The MIT License (MIT)

Copyright (c) 2013-2024 Michael Rose and contributors

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.

Minimal Mistakes incorporates icons fromThe Noun Projectcreators Garrett Knoll, Arthur Shlain, and tracy tam.Icons are distributed under Creative Commons Attribution 3.0 United States (CC BY 3.0 US).

Minimal Mistakes incorporatesFont Awesome,Copyright (c) 2017 Dave Gandy.Font Awesome is distributed under the terms of theSIL OFL 1.1andMIT License.

Minimal Mistakes incorporates photographs fromUnsplash.

Minimal Mistakes incorporatesSusy,Copyright (c) 2017, Miriam Eric Suzanne.Susy is distributed under the terms of theBSD 3-clause "New" or "Revised" License.

Minimal Mistakes incorporatesBreakpoint.Breakpoint is distributed under the terms of theMIT/GPL Licenses.

Minimal Mistakes incorporatesFitVids.js,Copyright (c) 2013 Dave Rubert and Chris Coyier.FitVids is distributed under the terms of theWTFPL License.

Minimal Mistakes incorporatesMagnific Popup,Copyright (c) 2014-2016 Dmitry Semenov,http://dimsemenov.com.Magnific Popup is distributed under the terms of the MIT License.

Minimal Mistakes incorporatesSmooth Scroll,Copyright (c) 2019 Chris Ferdinandi.Smooth Scroll is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesGumshoejs,Copyright (c) 2019 Chris Ferdinandi.Gumshoejs is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesjQuery throttle / debounce,Copyright (c) 2010 "Cowboy" Ben Alman.jQuery throttle / debounce is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesGreedyNav.js,Copyright (c) 2015 Luke Jackson.GreedyNav.js is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesJekyll Group-By-Array,Copyright (c) 2015 Max Whitemushishi78@gmail.com.Jekyll Group-By-Array is distributed under the terms of theMIT License.

Minimal Mistakes incorporates@allejo's Pure Liquid Jekyll Table of Contents,Copyright (c) 2017 Vladimir Jimenez.Pure Liquid Jekyll Table of Contents is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesLunr,Copyright (c) 2018 Oliver Nightingale.Lunr is distributed under the terms of theMIT License.

Minimal Mistakes incorporatesclipboard.js,Copyright (c) 2021 Zeno Rocha.Clipboard.js is distributed under the terms of theMIT License.