Use theme gem on GitHub Pages

[mmistakes]

GitHub Pages has whitelisted the Jekyll Remote Theme plugin which means Minimal Mistakes can finally be used without needing to fork this repo.

This is apparently in beta, but in my testing everything works as expected. To get up in running follow the instructions for the installing the Ruby gem version of the theme, then:

Step 1. Add the following to your _config.yml file

plugins:
  - jekyll-remote-theme

remote_theme: mmistakes/minimal-mistakes

Step 2. Add gem 'jekyll-remote-theme' to your Gemfile if building locally with the GitHub Pages gem.

An example repo can be viewed here, which is hosted on GitHub Pages.

[vg]

Any idea on how to use the different skins/color variations using remote_theme?

[mmistakes]

Haven't tested it but should work the same way you'd normally use them, set the skin you want in _config.yml.

minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"

[mmistakes]

Tested. Adding minimal_mistakes_skin and the variation you want to your _config.yml works as it should.

[vg]

I did test it before commenting above. It did not work. Here is the config.yml and the built site.

https://github.com/vg/mm-remote-theme-test/blob/master/_config.yml
https://vg.github.io/mm-remote-theme-test/

[mmistakes]

@vg It works, I just switched my demo site to dark. The reason it's not working for you is you didn't update the url in the _config.yml file. You still have it pointing to my repo's CSS.

You'll notice if you fire up your test repo it'll go from the default skin to dark because it's using the CSS from my test repo, not yours. Change this line to url: https://vg.github.io and it'll work.

[LongQi]

But if I modify the "locale", it did not work.

[mmistakes]

@LongQi You still need to commit the _data/ui-text.yml file. The test theme repo I built didn't include those so it just defaults back to English.

[ldt116]

Please add this good news to the doc, which is easier for newcomers to reach out.

Can you also post some migration guide for someone who forked repo to use the remote theme?

[mmistakes]

@ldt116 Docs were updated last week. See GitHub Pages compatible method in the Quick Start instructions.

https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/

For migration follow the guidelines under "Setup Your Site." You can ignore the Gemfile specific stuff as that only applies to the Ruby gem version.

https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#migrating-to-gem-version

[ldt116]

Oh. Thanks for pointing out. I missed that.