diff --git a/README.md b/README.md index f669daa4..01310044 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ 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](CHANGELOG.md). - -:sparkles: Minimal Mistakes is now available as a [Ruby gem](https://rubygems.org/gems/minimal-mistakes-jekyll). Consult the [Quick-Start Guide](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) and [this blog post](https://mmistakes.github.io/minimal-mistakes/jekyll/gemified-theme-beta/) to learn how to upgrade. +:sparkles: See what's new in the [CHANGELOG](CHANGELOG.md). [![Minimal Mistakes live preview][2]][1] @@ -17,15 +15,28 @@ See what's new in the [CHANGELOG](CHANGELOG.md). ## Notable Features -- "Gemified" for easier install/upgrading -- Compatible with Jekyll 3.5 and GitHub Pages -- Support for Jekyll's built-in Sass/SCSS preprocessor -- Several responsive layout options (single, archive index, splash, and paginated home page) -- SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data +- Bundled as a "theme gem" for easier install/upgrading. +- Compatible with GitHub Pages. +- Support for Jekyll's built-in Sass/SCSS preprocessor. +- Seven different skins (color variations). +- Several responsive layout options (single, archive index, splash, and paginated home page). +- Optimized for search engines with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data - Optional [header images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#headers), [custom sidebars](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#sidebars), [table of contents](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents), [galleries](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery), related posts, [breadcrumb links](https://mmistakes.github.io/minimal-mistakes/docs/configuration/#breadcrumb-navigation-beta), [navigation lists](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list), and more. -- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman](https://staticman.net/), and custom). +- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman v1](https://staticman.net/), and custom). - [Google Analytics](https://www.google.com/analytics/) support. -- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Korean, Nepali (Nepalese), Russian, Spanish, and Turkish +- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Korean, Nepali (Nepalese), Russian, Spanish, and Turkish. + +## Skins (Color Variations) + +This theme comes in seven different skins (including the default one). + +| `air` | `contrast` | `dark` | +| --- | --- | --- | +| ![air skin](https://mmistakes.github.io/minimal-mistakes/assets/images/air-skin-post.png) | ![contrast skin](https://mmistakes.github.io/minimal-mistakes/assets/images/contrast-skin-post.png) | ![dark skin](https://mmistakes.github.io/minimal-mistakes/assets/images/dark-skin-post.png) | + +| `dirt` | `mint` | `sunrise` | +| --- | --- | --- | +| ![dirt skin](https://mmistakes.github.io/minimal-mistakes/assets/images/dirt-skin-post.png) | ![mint skin](https://mmistakes.github.io/minimal-mistakes/assets/images/mint-skin-post.png) | ![sunrise skin](https://mmistakes.github.io/minimal-mistakes/assets/images/sunrise-skin-post.png) | ## Demo Pages