~xdavidwu/xdavidwu.link

2346e11acea3f75c4d5a51b19f8f085ea955b1df — Michael Rose 5 years ago c3b089e
Add notice for fixing `Unknown tag 'include_cached'`

Fixes #1875
2 files changed, 3 insertions(+), 1 deletions(-)

M CHANGELOG.md
M README.md
M CHANGELOG.md => CHANGELOG.md +1 -1
@@ 2,7 2,7 @@

### Enhancements

- Cache "static" includes to improve build performance. [#1874](https://github.com/mmistakes/minimal-mistakes/pull/1874)
- Cache "static" includes to improve build performance. **Note:** The theme uses the [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin which will need to be installed in your `Gemfile` and added to the `plugins` array of `_config.yml`. Otherwise you'll throw `Unknown tag 'include_cached'` errors at build. [#1874](https://github.com/mmistakes/minimal-mistakes/pull/1874)
- Make entire feature and archive items "clickable". [#1864](https://github.com/mmistakes/minimal-mistakes/pull/1864)
- Allow custom Staticman endpoints. [#1842](https://github.com/mmistakes/minimal-mistakes/issues/1842)
- Remove `type="text/css"` from Algolia script includes. [#1836](https://github.com/mmistakes/minimal-mistakes/pull/1836)

M README.md => README.md +2 -0
@@ 72,6 72,8 @@ Additional sample posts are available under [posts archive][year-archive] on the

There are three ways to install the theme: as a Ruby gem (for self-hosted sites), as a Ruby gem + jekyll-remote-theme plugin (GitHub Pages hosted sites), or forking/directly copying all of the theme files into your project.

**Note:** The theme uses the [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin which will need to be installed in your `Gemfile` and added to the `plugins` array of `_config.yml`. Otherwise you'll throw `Unknown tag 'include_cached'` errors at build.

### Ruby Gem Method

1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so: