@@ 1,4 1,4 @@
-# [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/)
+# [Minimal Mistakes Jekyll theme](https://mmistakes.github.io/minimal-mistakes/)
[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE)
[![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.6-blue.svg)](https://jekyllrb.com/)
@@ 22,7 22,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building per
![layout examples](screenshot-layouts.png)
-## Notable Features
+## Notable features
- Bundled as a "theme gem" for easier installation/upgrading.
- Compatible with GitHub Pages.
@@ 35,7 35,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building per
- [Google Analytics](https://www.google.com/analytics/) support.
- UI localized text in English (default), Brazilian Portuguese (Português brasileiro), Chinese, Danish, Dutch, French (Français), German (Deutsch), Greek, Hindi, Hungarian, Indonesian, Italian (Italiano), Japanese, Korean, Nepali (Nepalese), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Turkish (Türkçe), and Vietnamese.
-## Skins (Color Variations)
+## Skins (color variations)
This theme comes in nine different skins (including the default one).
@@ 51,7 51,7 @@ This theme comes in nine different skins (including the default one).
| --- | --- | --- |
| ![aqua skin](https://mmistakes.github.io/minimal-mistakes/assets/images/aqua-skin-archive.png) | ![neon skin](https://mmistakes.github.io/minimal-mistakes/assets/images/neon-skin-archive.png) | ![plum skin](https://mmistakes.github.io/minimal-mistakes/assets/images/plum-skin-archive.png) |
-## Demo Pages
+## Demo pages
| Name | Description |
| ------------------------------------------- | ----------------------------------------------------- |
@@ 76,11 76,15 @@ Additional sample posts are available under [posts archive][year-archive] on the
## Installation
-There are three ways to install the theme: as a Ruby gem (for self-hosted sites), as a Ruby gem + jekyll-remote-theme plugin (GitHub Pages hosted sites), or forking/directly copying all of the theme files into your project.
+There are three ways to install: as a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes), as a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible), or forking/directly copying all of the theme files into your project.
-### Ruby Gem Method
+### Gem-based method
-1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
+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:
+
+1. Add the following to your `Gemfile`:
```ruby
gem "minimal-mistakes-jekyll"
@@ 100,7 104,11 @@ There are three ways to install the theme: as a Ruby gem (for self-hosted sites)
To update the theme run `bundle update`.
-### GitHub Pages Method
+### 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:
1. Create/replace the contents of your `Gemfile` with the following:
@@ 110,13 118,15 @@ To update the theme run `bundle update`.
gem "github-pages", group: :jekyll_plugins
```
-2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
+2. Add `jekyll-include-cache` to the `plugins` array of your `_config.yml`.
+
+3. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
```bash
bundle
```
-3. Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
+4. Add `remote_theme: "mmistakes/minimal-mistakes@4.13.0"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
## Usage