Add note about installing additional dependencies when using gem "jekyll" instead of gem "github-pages"

- Fixes #305
This commit is contained in:
Michael Rose 2016-05-16 10:14:06 -04:00
parent 448df3c43d
commit 06414587b0

View File

@ -2,7 +2,7 @@
title: "Installation" title: "Installation"
permalink: /docs/installation/ permalink: /docs/installation/
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites." 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 %} {% include base_path %}
@ -66,6 +66,21 @@ If you're not planning on hosting with GitHub Pages and want to leverage feature
$ bundle install $ 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> <figure>
<img src="{{ base_path }}/images/mm-bundle-install.gif" alt="bundle install in Terminal window"> <img src="{{ base_path }}/images/mm-bundle-install.gif" alt="bundle install in Terminal window">
</figure> </figure>