Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit b2945bc

Browse files
committedSep 21, 2017
Clarify theme gem migration documentation
Include asset folders that should be removed when migrating from a "forked theme". Close mmistakes#1268
1 parent 611cd3a commit b2945bc

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed
 

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Enhancements
44

55
- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
6+
- 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)
67

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

‎docs/_docs/01-quick-start-guide.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Quick-Start Guide"
33
permalink: /docs/quick-start-guide/
44
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
5-
last_modified_at: 2017-09-01T09:27:53-04:00
5+
last_modified_at: 2017-09-21T16:16:40-04:00
66
redirect_from:
77
- /theme-setup/
88
---
@@ -130,9 +130,10 @@ Edit `_config.yml`. Then:
130130

131131
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.
132132

133-
Start by removing `_includes`, `_layouts`, `_sass`, `assets` folders and all files within.
133+
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).
134134

135-
You won't need these anymore as they're bundled with the theme gem.
135+
**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).
136+
{: .notice--warning}
136137

137138
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.
138139
The default files are read-in automatically via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin.

‎docs/_docs/18-history.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ permalink: /docs/history/
44
excerpt: "Change log of enhancements and bug fixes made to the theme."
55
sidebar:
66
nav: docs
7-
last_modified_at: 2017-09-20T15:58:39-04:00
7+
last_modified_at: 2017-09-21T16:17:50-04:00
88
---
99

1010
## Unreleased
1111

1212
### Enhancements
1313

1414
- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
15+
- 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)
1516

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

0 commit comments

Comments
 (0)