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

Add instructions on how to downgrade

Browse Source
This commit is contained in:
Michael Rose 2018-01-08 20:11:05 -05:00
parent bbf3cbc5fd
commit 49d09c6c5b
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -53,6 +53,8 @@ Run `bundle update` and verify that all gems install properly.
Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry. Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
You may also optionally specify a branch, [tag](https://github.com/mmistakes/minimal-mistakes/tags), or commit to use by appending an @ and the Git ref (e.g., `mmistakes/minimal-mistakes@4.9.0` or `mmistakes/minimal-mistakes@bbf3cbc5fd64a3e1885f3f99eb90ba92af84063d`). If you don't specify a Git ref, the master branch will be used.
--- ---
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details). **Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).

16
docs/_docs/04-upgrading.md
View File

@ -2,7 +2,7 @@
title: "Upgrading" title: "Upgrading"
permalink: /docs/upgrading/ permalink: /docs/upgrading/
excerpt: "Instructions and suggestions for upgrading the theme." excerpt: "Instructions and suggestions for upgrading the theme."
last_modified_at: 2018-01-08T12:10:30-05:00 last_modified_at: 2018-01-08T20:10:30-05:00
toc: true toc: true
--- ---
@ -25,11 +25,21 @@ At the top of every `.html` file, `/assets/css/main.css`, and `/assets/js/main.m
Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem update minimal-mistakes-jekyll` if you're not. Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem update minimal-mistakes-jekyll` if you're not.
When using Bundler you can downgrade or lock the theme to a specific release ([tag](https://github.com/mmistakes/minimal-mistakes/tags)), branch, or commit. Instead of `gem "minimal-mistakes-jekyll"` you'd add the following to your `Gemfile`:
```ruby
gem "minimal-mistakes-jekyll", :git => "https://github.com/mmistakes/minimal-mistakes.git", :tag => "4.9.0"
```
For more information on [installing gems from git repositories](http://bundler.io/v1.16/guides/git.html) consult Bundler's documentation.
## Remote Theme ## Remote Theme
When hosting with GitHub Pages you'll need to push up a commit to force a rebuild with the latest [theme release](https://github.com/mmistakes/minimal-mistakes/releases). When setting `remote_theme: "mmistakes/minimal-mistakes"` in your `_config.yml` you may also optionally specify a branch, [tag](https://github.com/mmistakes/minimal-mistakes/tags), or commit to use by appending an @ and the Git ref.
An empty commit will get the job done too if you don't have anything to push at the moment: For example you can roll back to release 4.8.1 with `mmistakes/minimal-mistakes@4.8.1` or a specific commit with `mmistakes/minimal-mistakes@bbf3cbc5fd64a3e1885f3f99eb90ba92af84063d`).
To update the theme on GitHub Pages you'll need to push up a commit to force a rebuild. An empty commit works well if you don't have anything to push at the moment:
```terminal ```terminal
git commit --allow-empty -m "Force rebuild of site" git commit --allow-empty -m "Force rebuild of site"