N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add note about GitHub Pages hosting alternatives

Browse source 
Ruby gem method can be used with Netlify, GitLab Pages, and Continous Integration (CI) services like Travis CI.
This commit is contained in:
Michael Rose 2017-09-01 09:32:30 -04:00
parent 5d5b05d2a2
commit 9b52f9c61d
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/_docs/01-quick-start-guide.md
View file

@ -2,7 +2,7 @@
title: "Quick-Start Guide" title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/ permalink: /docs/quick-start-guide/
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages." excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
last_modified_at: 2017-08-29T15:54:09-04:00 last_modified_at: 2017-09-01T09:27:53-04:00
redirect_from: redirect_from:
- /theme-setup/ - /theme-setup/
--- ---
@ -13,8 +13,7 @@ Minimal Mistakes has been developed as a [Jekyll theme gem](http://jekyllrb.com/
## Installing the Theme ## Installing the Theme
If you're running Jekyll v3.3+ and self-hosting you can quickly install the theme as Ruby gem. If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. If you're hosting with GitHub Pages you'll have to use the old "repo fork" method or directly copy all of the theme files[^structure] into your site.
If you're hosting with GitHub Pages you'll have to use the old "repo fork" method or directly copy all of the theme files[^structure] into your site.
[^structure]: See [**Structure** page]({{ "/docs/structure/" | absolute_url }}) for a list of theme files and what they do. [^structure]: See [**Structure** page]({{ "/docs/structure/" | absolute_url }}) for a list of theme files and what they do.
@ -76,6 +75,13 @@ end
Then run `bundle update` and verify that all gems install properly. Then run `bundle update` and verify that all gems install properly.
**GitHub Pages Alternatives:** Looking to host your site for free and install/update the theme painlessly? [Netflify][netlify-jekyll], [GitLab Pages][gitlab-jekyll], and [Continuous Integration (CI) services][ci-jekyll] have you covered. In most cases all you need to do is connect your repository to them, create a simple configuration file, and install the theme following the [Ruby Gem Method](#ruby-gem-method) above.
{: .notice--info}
[netlify-jekyll]: https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/
[gitlab-jekyll]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/
[ci-jekyll]: https://jekyllrb.com/docs/continuous-integration/
### Remove the Unnecessary ### Remove the Unnecessary
If you forked or downloaded the `minimal-mistakes-jekyll` repo you can safely remove the following folders and files: If you forked or downloaded the `minimal-mistakes-jekyll` repo you can safely remove the following folders and files: