New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use theme gem on GitHub Pages #1339

Closed
mmistakes opened this Issue Nov 7, 2017 · 10 comments

Comments

Projects
None yet
4 participants
@mmistakes
Owner

mmistakes commented Nov 7, 2017

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.

@mmistakes mmistakes added the Type: Idea label Nov 7, 2017

@vg

This comment has been minimized.

Show comment
Hide comment
@vg

vg Nov 8, 2017

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

vg commented Nov 8, 2017

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

@mmistakes

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Nov 8, 2017

Owner

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"
Owner

mmistakes commented Nov 8, 2017

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

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Nov 8, 2017

Owner

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

Owner

mmistakes commented Nov 8, 2017

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

@vg

This comment has been minimized.

Show comment
Hide comment
@vg

vg Nov 8, 2017

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/

vg commented Nov 8, 2017

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

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Nov 8, 2017

Owner

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

Owner

mmistakes commented Nov 8, 2017

@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

This comment has been minimized.

Show comment
Hide comment
@LongQi

LongQi Nov 10, 2017

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

LongQi commented Nov 10, 2017

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

@mmistakes

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Nov 10, 2017

Owner

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

Owner

mmistakes commented Nov 10, 2017

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

mmistakes added a commit that referenced this issue Nov 10, 2017

Update installation documentation
Include new `jekyll-remote-theme` method for using Ruby gem version of the theme with GitHub Pages hosted sites.

ref: #1339
@ldt116

This comment has been minimized.

Show comment
Hide comment
@ldt116

ldt116 Nov 14, 2017

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?

ldt116 commented Nov 14, 2017

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

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Nov 14, 2017

Owner

@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

Owner

mmistakes commented Nov 14, 2017

@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

This comment has been minimized.

Show comment
Hide comment
@ldt116

ldt116 Nov 15, 2017

Oh. Thanks for pointing out. I missed that.

ldt116 commented Nov 15, 2017

Oh. Thanks for pointing out. I missed that.

@mmistakes mmistakes closed this Nov 15, 2017

ihexon pushed a commit to ihexon/ihexon.github.io that referenced this issue Jul 16, 2018

Update installation documentation
Include new `jekyll-remote-theme` method for using Ruby gem version of the theme with GitHub Pages hosted sites.

ref: mmistakes/minimal-mistakes#1339

ihexon pushed a commit to ihexon/ihexon.github.io that referenced this issue Jul 19, 2018

Update installation documentation
Include new `jekyll-remote-theme` method for using Ruby gem version of the theme with GitHub Pages hosted sites.

ref: mmistakes/minimal-mistakes#1339
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment