Glavo/minimal-mistakes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update installation and upgrading documentation

Browse Source
This commit is contained in:
Michael Rose 2016-08-01 09:50:22 -04:00
parent 890a5e3eb2
commit a9357484aa
2 changed files with 8 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
_docs/03-installation.md
View File

@ -2,7 +2,7 @@
title: "Installation"
permalink: /docs/installation/
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites."
modified: 2016-05-16T10:07:40-04:00
modified: 2016-08-01T09:36:36-04:00
---
{% include base_path %}
@ -60,27 +60,15 @@ If this is your first time using Jekyll be sure to read through the [official do
To keep your sanity and better manage dependencies I strongly urge you to [install Bundler](http://bundler.io/) with `gem install bundler` and use the included [`Gemfile`](https://github.com/{{ site.repository }}/blob/master/Gemfile). The theme's Gemfile includes the `github-pages` gem to maintain a local Jekyll environment in sync with GitHub Pages.
If you're not planning on hosting with GitHub Pages and want to leverage features found in the latest version of Jekyll, replace `gem "github-pages"` with `gem "jekyll"` in your `Gemfile`. In either case run the following:
If you're not planning to host with GitHub Pages and want to leverage features found in the latest version of Jekyll, uncomment the `gem "jekyll"` line in your `Gemfile`. In either case run the following:
```bash
$ 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`.
**Note:** The [GitHub Pages gem](https://github.com/github/pages-gem) installs additional dependencies that may need to be added to your `Gemfile` if you decide to remove the `gem "github-pages"`.
{: .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>

7
_docs/04-upgrading.md
View File

@ -2,12 +2,15 @@
title: "Upgrading"
permalink: /docs/upgrading/
excerpt: "Instructions and suggestions for upgrading the theme."
modified: 2016-04-27T10:35:00-04:00
modified: 2016-08-01T09:43:46-04:00
---
{% include base_path %}
Currently there is no good way of upgrading the theme without doing a bit of manual work. The future looks promising with [**gem based themes**](https://github.com/jekyll/jekyll/pull/4595) on the horizon, but for now here's some suggestions on how handle theme updates.
Currently there is no good way of upgrading the theme without doing a bit of manual work. The future looks promising now that [**gem based themes**](https://jekyllrb.com/docs/themes/) have landed with Jekyll `v3.2`, but for now here's some suggestions on how to handle updates.
**Gemified Theme**: A future version of Minimal Mistakes will suppor the new Jekyll theme system. A few key features like theme assets (eg. fonts, images, and JavaScript) and support for GitHub Pages are currently missing for this enhancement to happen now. Stay tuned!
{: .notice--info}
## Use Git