Repository files navigation

Note: The theme uses thejekyll-include-cache plugin which will need to be installed in yourGemfile and added to theplugins array of_config.yml. Otherwise you'll throwUnknown tag 'include_cached' errors at build.

• 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 forTwitter Cards andOpen Graph data.
• Optionalheader images,custom sidebars,table of contents,galleries, related posts,breadcrumb links,navigation lists, and more.
• Commenting support (powered byDisqus,Facebook, Google+,Discourse, static-based viaStaticman, andutterances).
• Google 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, Malayalam, Nepali (Nepalese), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Turkish (Türkçe), and Vietnamese.

Additional sample posts are available underposts archive on the demo site. Source files for these (and the entire demo site) can be found in/docs.

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

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

To install:

1. Create/replace the contents of yourGemfile with the following:

   source"https://rubygems.org"gem"github-pages",group::jekyll_plugins

2. Addjekyll-include-cache to theplugins array of your_config.yml.

3. Fetch and update bundled gems by running the followingBundler command:

   bundle

4. Addremote_theme: "mmistakes/minimal-mistakes@4.15.1" to your_config.yml file. Remove any othertheme: orremote_theme: entry.

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

Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature orfixing a bug? Then by all meanssubmit an issue orpull request. If this is your first pull request, it may be helpful to read up on theGitHub 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 😄.

When submitting a pull request:

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

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

To test the theme, runbundle exec rake preview and open your browser athttp://localhost:4000/test/. This starts a Jekyll server using content in thetest/ 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.