:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
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 :smile:.
:sparkles: See what's new in the CHANGELOG.
If you enjoy this theme, please consider sponsoring:
Note: The theme uses the jekyll-include-cache plugin which will need to be installed in your
Gemfileand must be retained in the
_config.yml. Otherwise you'll encounter
Unknown tag 'include_cached'errors at build.
This theme comes in nine different skins (in addition to the default one).
dark| | --- | --- | --- | | | | |
sunrise| | --- | --- | --- | | | | |
plum| | --- | --- | --- | | | | |
| Name | Description | | ------------------------------------------- | ----------------------------------------------------- | | Post with Header Image | A post with a large header image. | | HTML Tags and Formatting Post | A variety of common markup showing how the theme styles them. | | Syntax Highlighting Post | Post displaying highlighted code. | | Post with a Gallery | A post showing several images wrapped inelements. | | Sample Collection Page | Single page from a collection. | | Categories Archive | Posts grouped by category. | | Tags Archive | Posts grouped by tag. |
Additional sample posts are available under posts archive on the demo site. Source files for these (and the entire demo site) can be found in
With Gem-based themes, directories such as the
_sassare 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:
themein your project's Jekyll
To update the theme run
Remote themes are similar to Gem-based themes, but do not require
Gemfilechanges or whitelisting making them ideal for sites hosted with GitHub Pages.
Gemfilewith the following:
gem "github-pages", group: :jekyll_plugins gem "jekyll-include-cache", group: :jekyll_plugins
pluginsarray of your
Fetch and update bundled gems by running the following Bundler command:
remote_theme: "mmistakes/[email protected]"to your
_config.ymlfile. Remove any other
Looking for an example? Use the Minimal 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 the theme's documentation.
Found a typo in the documentation or interested in fixing a bug? Then by all means submit an issue or pull request. If this is your first pull request, it may be helpful to read up on the GitHub Flow first.
For help with using the theme or general Jekyll support questions, please use the Jekyll Talk forums.
When submitting a pull request:
masterand give it a meaningful name (e.g.
To set up your environment to develop this theme, run
To test the theme, run
bundle exec rake previewand open your browser at
http://localhost:4000/test/. This starts a Jekyll server using content in the
test/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.
The MIT License (MIT)
Copyright (c) 2013-2020 Michael Rose and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 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 THE SOFTWARE.
Minimal Mistakes incorporates icons from The Noun Project creators 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 incorporates photographs from Unsplash.
Minimal Mistakes incorporates Magnific Popup, Copyright (c) 2014-2016 Dmitry Semenov, http://dimsemenov.com. Magnific Popup is distributed under the terms of the MIT 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 the MIT License.