Skip to content

Commit

Permalink
Clarify theme gem migration documentation
Browse files Browse the repository at this point in the history
Include asset folders that should be removed when migrating from a "forked theme".

Close mmistakes#1268
  • Loading branch information
mmistakes committed Sep 21, 2017
1 parent 5e04bf2 commit f89e7f0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
### Enhancements

- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
- Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268)

## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)

Expand Down
7 changes: 4 additions & 3 deletions docs/_docs/01-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
last_modified_at: 2017-09-01T09:27:53-04:00
last_modified_at: 2017-09-21T16:16:40-04:00
redirect_from:
- /theme-setup/
---
Expand Down Expand Up @@ -130,9 +130,10 @@ Edit `_config.yml`. Then:

If you're migrating a site already using Minimal Mistakes and haven't customized any of the theme files things upgrading will be easier for you.

Start by removing `_includes`, `_layouts`, `_sass`, `assets` folders and all files within.
Start by removing the following folders: `_includes`, `_layouts`, `_sass`, `assets/css`, `assets/fonts`, `assets/js` and the files within. You won't need these anymore as they're bundled with the theme gem --- unless you intend to [override them](http://jekyllrb.com/docs/themes/#overriding-theme-defaults).

You won't need these anymore as they're bundled with the theme gem.
**Note:** When clearing out the `assets` folder be sure to leave any files you've added. This includes images, CSS, or JavaScript that aren't already [bundled in the theme](https://github.com/mmistakes/minimal-mistakes/tree/master/assets).
{: .notice--warning}

From `v4.5.0` onwards, you don't have to maintain a copy of the default data files viz. `_data/ui-text.yml` and `_data/navigation.yml` either.
The default files are read-in automatically via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin.
Expand Down
3 changes: 2 additions & 1 deletion docs/_docs/18-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ permalink: /docs/history/
excerpt: "Change log of enhancements and bug fixes made to the theme."
sidebar:
nav: docs
last_modified_at: 2017-09-20T15:58:39-04:00
last_modified_at: 2017-09-21T16:17:50-04:00
---

## Unreleased

### Enhancements

- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
- Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268)

## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)

Expand Down

0 comments on commit f89e7f0

Please sign in to comment.