* Update documentation for #2621 * Update CHANGELOG and history * Update last_modified_at
This commit is contained in:
iBug ♦
GitHub
parent
83b4dba2f0
commit
a695d7728f
|
|
@ -18,6 +18,7 @@
|
|||
- Ignore teaser headline in table of contents when including posts list in another page. [#2558](https://github.com/mmistakes/minimal-mistakes/pull/2558)
|
||||
- Replace Font Awesome Kits with CSS from jsDelivr CDN. [#2583](https://github.com/mmistakes/minimal-mistakes/pull/2583)
|
||||
- Add `danmaku` option to Bilibili video provider and add corresponding documentation/ [#2599](https://github.com/mmistakes/minimal-mistakes/pull/2599)
|
||||
- Update documentation about loading l10n data file from the theme-gem. [#2621](https://github.com/mmistakes/minimal-mistakes/issues/2621) [#2624](https://github.com/mmistakes/minimal-mistakes/pull/2624)
|
||||
|
||||
## [4.19.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.19.3)
|
||||
|
||||
|
|
|
|||
|
|
@ -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: 2020-04-27
|
||||
last_modified_at: 2020-07-27
|
||||
redirect_from:
|
||||
- /theme-setup/
|
||||
toc: true
|
||||
|
|
@ -136,12 +136,17 @@ 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/" | relative_url }}) section.
|
||||
|
||||
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.
|
||||
From `v4.5.0` onwards, Minimal Mistakes theme-gem comes bundled with the necessary data files for localization.
|
||||
They will be picked up automatically if you have the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin installed.
|
||||
If you're hosting on GitHub Pages, you can copy the [`_data/ui-text.yml`][ui-text.yml] file into your repository for the localization feature to work.
|
||||
|
||||
You'll need to create and edit these data files to customize them:
|
||||
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | relative_url }})
|
||||
- [`_data/ui-text.yml`][ui-text.yml] - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
|
||||
- [`_data/navigation.yml`][navigation.yml] - navigation [documentation]({{ "/docs/navigation/" | relative_url }})
|
||||
|
||||
[ui-text.yml]: https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml
|
||||
[navigation.yml]: https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml
|
||||
|
||||
### Starting from `jekyll new`
|
||||
|
||||
|
|
@ -174,8 +179,7 @@ You won't need these anymore as they're bundled with the theme gem --- unless yo
|
|||
**Note:** When clearing out the `assets` folder be sure to leave any files you've added and need. 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.
|
||||
From `v4.5.0` onwards, the default language files are read-in automatically via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin if it's installed. For sites hosted with GitHub Pages, you still need to copy the [`_data/ui-text.yml`][ui-text.yml] file because the `jekyll-data` plugin [is unsupported on GitHub Pages](https://docs.github.com/en/github/working-with-github-pages/about-github-pages-and-jekyll#plugins).
|
||||
|
||||
If you customized any of these files leave them alone, and only remove the untouched ones. If done correctly your modified versions should [override](https://jekyllrb.com/docs/themes/#overriding-theme-defaults) the versions bundled with the theme and be used by Jekyll instead.
|
||||
|
||||
|
|
@ -196,7 +200,7 @@ When finished your `Gemfile` should look something like this:
|
|||
```ruby
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "jekyll", "~> 3.5"
|
||||
gem "jekyll", "~> 3.7"
|
||||
gem "minimal-mistakes-jekyll"
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Overriding Theme Defaults"
|
||||
permalink: /docs/overriding-theme-defaults/
|
||||
excerpt: "Instructions on how to customize the theme's default set of layouts, includes, and stylesheets when using the Ruby Gem version."
|
||||
last_modified_at: 2018-03-20T15:59:31-04:00
|
||||
last_modified_at: 2020-07-27
|
||||
---
|
||||
|
||||
When installing the theme as a Ruby Gem its layouts, includes, stylesheets, and other assets are all bundled in the `gem`. Meaning they're not easily visible in your project.
|
||||
|
|
@ -21,7 +21,8 @@ Jekyll will use the files in your project first before falling back to the defau
|
|||
/_sass
|
||||
```
|
||||
|
||||
Additionally, from `v4.5.0` the theme-gem will also exhibit above behavior for `/_data` via a plugin.
|
||||
Additionally, from `v4.5.0` onwards 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.
|
||||
This doesn't apply if you're building your site on GitHub Pages, however.
|
||||
|
||||
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | relative_url }}) and [JavaScript]({{ "/docs/javascript/" | relative_url }}), see the appropriate pages.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ permalink: /docs/history/
|
|||
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
||||
sidebar:
|
||||
nav: docs
|
||||
last_modified_at: 2020-07-24T15:55:22-04:00
|
||||
last_modified_at: 2020-07-27T12:00:00+08:00
|
||||
toc: false
|
||||
---
|
||||
|
||||
|
|
@ -29,6 +29,7 @@ toc: false
|
|||
- Ignore teaser headline in table of contents when including posts list in another page. [#2558](https://github.com/mmistakes/minimal-mistakes/pull/2558)
|
||||
- Replace Font Awesome Kits with CSS from jsDelivr CDN. [#2583](https://github.com/mmistakes/minimal-mistakes/pull/2583)
|
||||
- Add `danmaku` option to Bilibili video provider and add corresponding documentation/ [#2599](https://github.com/mmistakes/minimal-mistakes/pull/2599)
|
||||
- Update documentation about loading l10n data file from the theme-gem. [#2621](https://github.com/mmistakes/minimal-mistakes/issues/2621) [#2624](https://github.com/mmistakes/minimal-mistakes/pull/2624)
|
||||
|
||||
## [4.19.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.19.3)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue