You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_docs/01-quick-start-guide.md
+13-5
Original file line number
Diff line number
Diff line change
@@ -99,7 +99,10 @@ Depending on the path you took installing Minimal Mistakes you'll setup things a
99
99
100
100
Starting with an empty folder and `Gemfile` you'll need to copy or re-create this [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) file. For a full explanation of every setting be sure to read the [**Configuration**]({{ "/docs/configuration/" | absolute_url }}) section.
101
101
102
-
After taking care of Jekyll's configuration file, you'll need to create and edit the following data files.
102
+
From `v4.5.0` onwards, Minimal Mistakes theme-gem comes bundled with the necessary data files and will automatically use them via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin. So you no longer need to maintain a copy of these data files at your project directory.
103
+
104
+
However like all other bundled files, you'll need to create and edit these data files to customize them.
105
+
The bundled data files are:
103
106
104
107
-[`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
@@ -108,7 +111,7 @@ After taking care of Jekyll's configuration file, you'll need to create and edit
108
111
109
112
Scaffolding out a site with the `jekyll new` command requires you to modify a few files that it creates.
110
113
111
-
Edit `_config.yml` and create `_data/ui-text.yml` and `_data/navigation.yml` same as above. Then:
114
+
Edit `_config.yml`. Then:
112
115
113
116
- Replace `<site root>/index.md` with a modified [Minimal Mistakes `index.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/index.html). Be sure to enable pagination if using the [`home` layout]({{ "/docs/layouts/#home-page" | absolute_url }}) by adding the necessary lines to **_config.yml**.
114
117
- Change `layout: post` in `_posts/0000-00-00-welcome-to-jekyll.markdown` to `layout: single`.
@@ -118,13 +121,18 @@ Edit `_config.yml` and create `_data/ui-text.yml` and `_data/navigation.yml` sam
118
121
119
122
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.
120
123
121
-
Start by removing `_includes`, `_layouts`, `_sass`, `assets` folders and all files within. You won't need these anymore as they're bundled with the theme gem.
124
+
Start by removing `_includes`, `_layouts`, `_sass`, `assets` folders and all files within.
125
+
126
+
You won't need these anymore as they're bundled with the theme gem.
127
+
128
+
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.
129
+
The default files are read-in automatically via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin.
122
130
123
131
If you customized any of these files leave them alone, and only remove the untouched ones. If done correctly your modified versions should [override](http://jekyllrb.com/docs/themes/#overriding-theme-defaults) the versions bundled with the theme and be used by Jekyll instead.
124
132
125
133
#### Update Gemfile
126
134
127
-
Replace `gem "github-pages` or `gem "jekyll"` with `gem "jekyll", "~> 3.3.0"`. You'll need the latest version of Jekyll[^update-jekyll] for Minimal Mistakes to work and load all of the theme's assets properly, this line forces Bundler to do that.
135
+
Replace `gem "github-pages` or `gem "jekyll"` with `gem "jekyll", "~> 3.5"`. You'll need the latest version of Jekyll[^update-jekyll] for Minimal Mistakes to work and load all of the theme's assets properly, this line forces Bundler to do that.
128
136
129
137
[^update-jekyll]: You could also run `bundle update jekyll` to update Jekyll.
130
138
@@ -139,7 +147,7 @@ When finished your `Gemfile` should look something like this:
Copy file name to clipboardExpand all lines: docs/_docs/06-overriding-theme-defaults.md
+3
Original file line number
Diff line number
Diff line change
@@ -21,4 +21,7 @@ Jekyll will use the files in your project first before falling back to the defau
21
21
/_sass
22
22
```
23
23
24
+
Additionally, from `v4.5.0` the theme-gem will also exhibit above behavior for `/_data` via a plugin.
25
+
Consequently, the data files for UI Text and Navigation are also bundled within the theme-gem.
26
+
24
27
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | absolute_url }}) and [JavaScript]({{ "/docs/javascript/" | absolute_url }}), see the appropriate pages.
0 commit comments