N-archive/hacks-guide-minimal-mistakes-theme

2020-10-23 13:37:42 -04:00

16 KiB

Raw Blame History

Minimal Mistakes Jekyll theme

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 the CHANGELOG.

If you enjoy this theme, please consider supporting me to continue developing and maintaining it.

Note: The theme uses the jekyll-include-cache plugin which will need to be installed in your Gemfile and added to the plugins array of _config.yml. Otherwise you'll encounter Unknown tag 'include_cached' errors at build.

Notable features

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 for Twitter Cards and Open Graph data.
Optional header images, custom sidebars, table of contents, galleries, related posts, breadcrumb links, navigation lists, and more.
Commenting support (powered by Disqus, Facebook, Google+, Discourse, static-based via Staticman, and utterances).
Google Analytics support.
UI localized text in English (default), Brazilian Portuguese (Português brasileiro), Catalan, Chinese, Danish, Dutch, Finnish, French (Français), German (Deutsch), Greek, Hindi (हिंदी), Hungarian, Indonesian, Irish (Gaeilge), Italian (Italiano), Japanese, Korean, Malayalam, Myanmar (Burmese), Nepali (Nepalese), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Thai, Turkish (Türkçe), and Vietnamese.

Skins (color variations)

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

`air`	`contrast`	`dark`

`dirt`	`mint`	`sunrise`

`aqua`	`neon`	`plum`

Demo pages

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 in `<figure>` elements.
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 /docs.

Installation

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

Gem-based method

With Gem-based themes, directories such as the assets, _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:

Add the following to your Gemfile:
```
gem "minimal-mistakes-jekyll"
```
Fetch and update bundled gems by running the following Bundler command:
```
bundle
```
Set the theme in your project's Jekyll _config.yml file:
```
theme: minimal-mistakes-jekyll
```

To update the theme run bundle update.

Remote theme method

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

To install:

Create/replace the contents of your Gemfile with the following:

source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins

Add jekyll-include-cache to the plugins array of your _config.yml.
Fetch and update bundled gems by running the following Bundler command:
```
bundle
```
Add remote_theme: "mmistakes/minimal-mistakes@4.20.2" to your _config.yml file. Remove any other theme: or remote_theme: entry.

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.

Usage

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

Contributing

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.

Pull Requests

When submitting a pull request:

Clone the repo.
Create a branch off of master and give it a meaningful name (e.g. my-awesome-new-feature).
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.

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

Credits

Creator

Michael Rose

Icons + Demo Images:

The Noun Project -- Garrett Knoll, Arthur Shlain, and tracy tam
Font Awesome
Unsplash

Other:

License

The MIT License (MIT)

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 Breakpoint. Breakpoint is distributed under the terms of the MIT/GPL Licenses.

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.

16 KiB Raw Blame History Unescape Escape