Update documentation (#1151)
* Update Quickstart documentation * update Installation documentation * Update documentation for Overriding Defaults
This commit is contained in:
parent
65a3d68dec
commit
d8be6fd2b5
3 changed files with 26 additions and 12 deletions
|
@ -99,7 +99,10 @@ Depending on the path you took installing Minimal Mistakes you'll setup things a
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
After taking care of Jekyll's configuration file, you'll need to create and edit the following data files.
|
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.
|
||||||
|
|
||||||
|
However like all other bundled files, you'll need to create and edit these data files to customize them.
|
||||||
|
The bundled data files are:
|
||||||
|
|
||||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
|
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
|
||||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | absolute_url }})
|
- [`_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
|
||||||
|
|
||||||
Scaffolding out a site with the `jekyll new` command requires you to modify a few files that it creates.
|
Scaffolding out a site with the `jekyll new` command requires you to modify a few files that it creates.
|
||||||
|
|
||||||
Edit `_config.yml` and create `_data/ui-text.yml` and `_data/navigation.yml` same as above. Then:
|
Edit `_config.yml`. Then:
|
||||||
|
|
||||||
- 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**.
|
- 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**.
|
||||||
- Change `layout: post` in `_posts/0000-00-00-welcome-to-jekyll.markdown` to `layout: single`.
|
- 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
|
||||||
|
|
||||||
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.
|
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. You won't need these anymore as they're bundled with the theme gem.
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
#### Update Gemfile
|
#### Update Gemfile
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
[^update-jekyll]: You could also run `bundle update jekyll` to update Jekyll.
|
[^update-jekyll]: You could also run `bundle update jekyll` to update Jekyll.
|
||||||
|
|
||||||
|
@ -139,7 +147,7 @@ When finished your `Gemfile` should look something like this:
|
||||||
```ruby
|
```ruby
|
||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|
||||||
gem "jekyll", "~> 3.3.0"
|
gem "jekyll", "~> 3.5"
|
||||||
gem "minimal-mistakes-jekyll"
|
gem "minimal-mistakes-jekyll"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -74,16 +74,19 @@ source "https://rubygems.org"
|
||||||
|
|
||||||
# To upgrade, run `bundle update`.
|
# To upgrade, run `bundle update`.
|
||||||
|
|
||||||
gem "jekyll", "~> 3.3.0"
|
gem "jekyll", "~> 3.5"
|
||||||
gem "minimal-mistakes-jekyll"
|
gem "minimal-mistakes-jekyll"
|
||||||
|
|
||||||
# If you have any plugins, put them here!
|
# The following plugins are automatically loaded by the theme-gem:
|
||||||
|
# gem "jekyll-paginate"
|
||||||
|
# gem "jekyll-sitemap"
|
||||||
|
# gem "jekyll-gist"
|
||||||
|
# gem "jekyll-feed"
|
||||||
|
# gem "jemoji"
|
||||||
|
# gem "jekyll-data"
|
||||||
|
#
|
||||||
|
# If you have any other plugins, put them here!
|
||||||
group :jekyll_plugins do
|
group :jekyll_plugins do
|
||||||
gem "jekyll-paginate"
|
|
||||||
gem "jekyll-sitemap"
|
|
||||||
gem "jekyll-gist"
|
|
||||||
gem "jekyll-feed"
|
|
||||||
gem "jemoji"
|
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -21,4 +21,7 @@ Jekyll will use the files in your project first before falling back to the defau
|
||||||
/_sass
|
/_sass
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Additionally, from `v4.5.0` the theme-gem will also exhibit above behavior for `/_data` via a plugin.
|
||||||
|
Consequently, the data files for UI Text and Navigation are also bundled within the theme-gem.
|
||||||
|
|
||||||
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | absolute_url }}) and [JavaScript]({{ "/docs/javascript/" | absolute_url }}), see the appropriate pages.
|
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | absolute_url }}) and [JavaScript]({{ "/docs/javascript/" | absolute_url }}), see the appropriate pages.
|
Loading…
Reference in a new issue