Update installation documentation

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

ref: https://github.com/mmistakes/minimal-mistakes/issues/1339
This commit is contained in:
Michael Rose
2017-11-10 11:20:38 -05:00
parent 4172237709
commit 6d9db31ef0
2 changed files with 52 additions and 36 deletions

View File

@ -65,34 +65,60 @@ Additional sample posts are available under [posts archive][year-archive] on the
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
## Usage
## Installation
For detailed instructions on how to configure, customize, add content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
There are three ways to install the theme: as a Ruby gem (for self-hosted sites), as a Ruby gem + jekyll-remote-theme plugin (GitHub Pages hosted sites), or forking/directly copying all of the theme files into your project.
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not currently supported on [GitHub Pages](https://pages.github.com/). You can still use the theme with GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
### Ruby Gem Method
## Quick Start
1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "minimal-mistakes-jekyll"
```
```ruby
gem "minimal-mistakes-jekyll"
```
2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
Add this line to your Jekyll site's `_config.yml` file:
```bash
bundle
```
```yaml
theme: minimal-mistakes-jekyll
```
3. Set the `theme` in your project's Jekyll `_config.yml` file:
Then run Bundler to install the theme gem and dependencies:
```bash
bundle install
```
```yaml
theme: minimal-mistakes-jekyll
```
To update the theme run `bundle update`.
## GitHub Pages Compatible Methods
1. Create/replace the contents of your `Gemfile` with the following:
```ruby
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
gem "jekyll-remote-theme"
```
2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
```bash
bundle
```
3. Add `jekyll-remote-theme` to the `plugins` (previously gems) array in your `_config.yml` file:
```yaml
plugins:
- jekyll-remote-theme
```
## Usage
For detailed instructions on how to configure, customize, add/migrate content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
---
## Contributing