Skip to content

Commit

Permalink
Add note about installing additional dependencies when using `gem "je…
Browse files Browse the repository at this point in the history
…kyll"` instead of `gem "github-pages"`

- Fixes #305
  • Loading branch information
mmistakes committed May 16, 2016
1 parent 448df3c commit 0641458
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion _docs/03-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Installation"
permalink: /docs/installation/
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites."
modified: 2016-04-28T11:12:50-04:00
modified: 2016-05-16T10:07:40-04:00
---

{% include base_path %}
Expand Down Expand Up @@ -66,6 +66,21 @@ If you're not planning on hosting with GitHub Pages and want to leverage feature
$ bundle install
```

**Note:** The [GitHub Pages gem](https://github.com/github/pages-gem) installs additional dependencies that need to be added to your `Gemfile` if you replace `gem "github-pages"` with `gem "jekyll"`. To do this add the following gems and then run `bundle install`.
{: .notice--warning}

```ruby
source "https://rubygems.org"
gem "jekyll"
gem "jekyll-paginate"
gem "jekyll-sitemap"
gem "jekyll-gist"
gem "jekyll-feed"
gem "jemoji"
gem "wdm", "~> 0.1.0" if Gem.win_platform?
```

<figure>
<img src="{{ base_path }}/images/mm-bundle-install.gif" alt="bundle install in Terminal window">
</figure>
Expand Down

0 comments on commit 0641458

Please sign in to comment.