Skip to content

Commit 369933e

Browse files
ashmarolimmistakes
authored andcommitted
Update documentation (mmistakes#1151)
* Update Quickstart documentation * update Installation documentation * Update documentation for Overriding Defaults
1 parent a742ca8 commit 369933e

File tree

3 files changed

+26
-12
lines changed

3 files changed

+26
-12
lines changed

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

+13-5
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,10 @@ Depending on the path you took installing Minimal Mistakes you'll setup things a
9999

100100
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.
101101

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:
103106

104107
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
105108
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | absolute_url }})
@@ -108,7 +111,7 @@ After taking care of Jekyll's configuration file, you'll need to create and edit
108111

109112
Scaffolding out a site with the `jekyll new` command requires you to modify a few files that it creates.
110113

111-
Edit `_config.yml` and create `_data/ui-text.yml` and `_data/navigation.yml` same as above. Then:
114+
Edit `_config.yml`. Then:
112115

113116
- 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**.
114117
- 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
118121

119122
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.
120123

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.
122130

123131
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.
124132

125133
#### Update Gemfile
126134

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.
128136

129137
[^update-jekyll]: You could also run `bundle update jekyll` to update Jekyll.
130138

@@ -139,7 +147,7 @@ When finished your `Gemfile` should look something like this:
139147
```ruby
140148
source "https://rubygems.org"
141149

142-
gem "jekyll", "~> 3.3.0"
150+
gem "jekyll", "~> 3.5"
143151
gem "minimal-mistakes-jekyll"
144152
```
145153

docs/_docs/03-installation.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,19 @@ source "https://rubygems.org"
7474

7575
# To upgrade, run `bundle update`.
7676

77-
gem "jekyll", "~> 3.3.0"
77+
gem "jekyll", "~> 3.5"
7878
gem "minimal-mistakes-jekyll"
7979

80-
# If you have any plugins, put them here!
80+
# The following plugins are automatically loaded by the theme-gem:
81+
# gem "jekyll-paginate"
82+
# gem "jekyll-sitemap"
83+
# gem "jekyll-gist"
84+
# gem "jekyll-feed"
85+
# gem "jemoji"
86+
# gem "jekyll-data"
87+
#
88+
# If you have any other plugins, put them here!
8189
group :jekyll_plugins do
82-
gem "jekyll-paginate"
83-
gem "jekyll-sitemap"
84-
gem "jekyll-gist"
85-
gem "jekyll-feed"
86-
gem "jemoji"
8790
end
8891
```
8992

docs/_docs/06-overriding-theme-defaults.md

+3
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,7 @@ Jekyll will use the files in your project first before falling back to the defau
2121
/_sass
2222
```
2323

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+
2427
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

Comments
 (0)