steffen/website
1
0
Fork 0
Code Actions Packages Releases Activity

Update installation documenation

Browse Source
This commit is contained in:
Michael Rose
2017-11-07 20:50:25 -05:00
parent c36d305fa9
commit 4172237709
2 changed files with 30 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/_docs/01-quick-start-guide.md
View File

@@ -2,7 +2,7 @@
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
last_modified_at: 2017-10-20T12:34:04-04:00
last_modified_at: 2017-11-07T20:48:04-05:00
redirect_from:
- /theme-setup/
toc: true
@@ -12,7 +12,7 @@ Minimal Mistakes has been developed as a [Jekyll theme gem](http://jekyllrb.com/
## Installing the Theme
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 running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem.
[^structure]: See [**Structure** page]({{ "/docs/structure/" | absolute_url }}) for a list of theme files and what they do.
@@ -39,9 +39,29 @@ Then run Bundler to install the theme gem and dependencies:
bundle install
```
### GitHub Pages Compatible Method
### GitHub Pages Compatible Methods
Fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
If you're hosting with GitHub Pages follow these steps instead:
Replace `gem "jekyll"` with:
```
gem "github-pages", group: :jekyll_plugins
gem "jekyll-remote-theme"
```
Then run `bundle update` and verify that all gems install properly.
Finally add `jekyll-remote-theme` to the `plugins` (previously gems) array in your `_config.yml` file like so:
```
plugins:
- jekyll-remote-theme
```
You can also install the theme by forking or copying all of the theme files[^structure] into your site.
To do so fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
<figure>
<img src="{{ '/assets/images/mm-theme-fork-repo.png' | absolute_url }}" alt="fork Minimal Mistakes">
@@ -62,14 +82,6 @@ Replace the contents of `Gemfile` found in the root of your Jekyll site with the
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
group :jekyll_plugins do
gem "jekyll-paginate"
gem "jekyll-sitemap"
gem "jekyll-gist"
gem "jekyll-feed"
gem "jemoji"
end
```
Then run `bundle update` and verify that all gems install properly.