minimal mistakes

1464 Stars

Theme author

Minimal Mistakes Jekyll Theme


GitHub release GitHub license


Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your personal site, blog, or portfolio on GitHub or self-hosting on your own server. As the name implies --- styling is purposely minimalistic to be enhanced and customized by you :smile:.


See what's new in the CHANGELOG.


:sparkles: Minimal Mistakes is now available as a Ruby gem. Consult the Quick-Start Guide and this blog post to learn how to upgrade.


Minimal Mistakes live preview


layout examples


Notable Features



Demo Pages







































NameDescription
Post with Header ImageA post with a large header image.
HTML Tags and Formatting PostA variety of common markup showing how the theme styles them.
Syntax Highlighting PostPost displaying highlighted code.
Post with a GalleryA post showing several images wrapped in <figure> elements.
Sample Collection PageSingle page from a collection.
Categories ArchivePosts grouped by category.
Tags ArchivePosts grouped by tags.

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 /docs.


Usage


For detailed instructions on how to configure, customize, add content, and more read the theme's documentation.


Note: Gem version of the theme requires Jekyll v3.3+ and is not currently supported on GitHub Pages. You can still use the theme with GitHub Pages, you'll just need to install using the old "repo fork method".


Quick Start


Add this line to your Jekyll site's Gemfile:


gem "minimal-mistakes-jekyll"

Add this line to your Jekyll site's _config.yml file:


theme: minimal-mistakes-jekyll

Then run Bundler to install the theme gem and dependencies:


bundle install

To update the theme run bundle update.




Contributing


Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or 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.


Minimal Mistakes has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask.


This goes for author sidebar links and "share button" additions -- I have no intention of merging in every possibly option, the essentials are there to get you started :smile:.


Pull Requests


To help me out try to avoid creating pull requests on master and instead branch off of develop. It's much easier for me to test, merge, and roll them into new releases this way.


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


Development


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


To test the theme, run bundle exec rake preview and open your browser at http://localhost:4000/test/. This starts a Jekyll server using your theme and the contents of the test/ directory. As you make modifications to your theme and to the example site, your site will regenerate and you should see the changes in the browser after a refresh.




Credits


Creator


Michael Rose



Icons + Demo Images:



Other:





License


The MIT License (MIT)


Copyright (c) 2016 Michael Rose


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.