From 2a323940b7ae20044b183a26f6f3049eafb5ef3c Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Thu, 4 Oct 2018 20:17:37 -0400 Subject: [PATCH] Add notice for fixing `Unknown tag 'include_cached'` Fixes #1875 --- CHANGELOG.md | 2 +- README.md | 2 ++ docs/_docs/01-quick-start-guide.md | 5 ++++- docs/_docs/03-installation.md | 8 ++++++-- docs/_docs/05-configuration.md | 22 ++++++++++++++-------- docs/_docs/18-history.md | 4 ++-- 6 files changed, 29 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50826973..fce8401d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/README.md b/README.md index b7afc8b8..0a38c37d 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/docs/_docs/01-quick-start-guide.md b/docs/_docs/01-quick-start-guide.md index fb62d7d5..d21ba0c6 100644 --- a/docs/_docs/01-quick-start-guide.md +++ b/docs/_docs/01-quick-start-guide.md @@ -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: 2018-07-19T11:31:38-04:00 +last_modified_at: 2018-10-04T20:15:56-04:00 redirect_from: - /theme-setup/ toc: true @@ -19,6 +19,9 @@ If you're running Jekyll v3.5+ and self-hosting you can quickly install the them **ProTip:** Be sure to remove `/docs` and `/test` if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't want them littering up your repo. {: .notice--info} +**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. +{: .notice--warning} + ### Ruby Gem Method Add this line to your Jekyll site's `Gemfile`: diff --git a/docs/_docs/03-installation.md b/docs/_docs/03-installation.md index 0bfc3f02..10e4748d 100644 --- a/docs/_docs/03-installation.md +++ b/docs/_docs/03-installation.md @@ -2,7 +2,7 @@ title: "Installation" permalink: /docs/installation/ excerpt: "Instructions for installing the theme for new and existing Jekyll based sites." -last_modified_at: 2018-03-20T15:59:00-04:00 +last_modified_at: 2018-10-04T20:16:07-04:00 toc: true --- @@ -21,6 +21,9 @@ If you plan to host with GitHub Pages be sure to properly setup [**jekyll-remote **ProTip:** Be sure to remove `/docs` and `/test` if you forked or downloaded Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't littering up in your repo. {: .notice--info} +**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. +{: .notice--warning} + ## Theme Migration To move over any existing content you'll want to copy the contents of your `_posts` folder to the new site. Along with any pages, collections, data files, images, or other assets you may have. @@ -80,6 +83,7 @@ gem "minimal-mistakes-jekyll" # gem "jekyll-feed" # gem "jemoji" # gem "jekyll-data" +# gem "jekyll-include-cache" # # If you have any other plugins, put them here! group :jekyll_plugins do @@ -95,7 +99,7 @@ To maintain a local Jekyll environment in sync with GitHub Pages replace the `ge $ bundle install ``` -**Note:** The [GitHub Pages gem](https://github.com/github/pages-gem) installs additional dependencies that may need to be added to your `Gemfile` if you decide to remove the `gem "github-pages"` eg. `jekyll-paginate`, `jekyll-sitemap`, `jekyll-feed`, etc. +**Note:** The [GitHub Pages gem](https://github.com/github/pages-gem) installs additional dependencies that may need to be added to your `Gemfile` if you decide to remove the `gem "github-pages"` eg. `jekyll-paginate`, `jekyll-sitemap`, `jekyll-feed`, `jekyll-include-cache`, etc. {: .notice--warning}
diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 5bc9b333..e59eabec 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -2,7 +2,7 @@ title: "Configuration" permalink: /docs/configuration/ excerpt: "Settings for configuring and customizing the theme." -last_modified_at: 2018-08-15T09:50:11-04:00 +last_modified_at: 2018-10-04T20:15:46-04:00 toc: true --- @@ -494,6 +494,7 @@ For faster and more relevant search ([see demo](https://mmistakes.github.io/mini gem "jekyll-seo-tag" gem "jekyll-sitemap" gem "jekyll-paginate" + gem "jekyll-include-cache" gem "jekyll-algolia" end ``` @@ -893,22 +894,27 @@ timezone: America/New_York When hosting with GitHub Pages a small [set of gems](https://pages.github.com/versions/) have been whitelisted for use. The theme uses a few of them which can be found under `gems`. Additional settings and configurations are documented in the links below. -| Plugin | Description | -| ---------------------------------- | ----------------------------------------------------------------------------------------- | -| [jekyll-paginate][jekyll-paginate] | Pagination Generator for Jekyll. | -| [jekyll-sitemap][jekyll-sitemap] | Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site. | -| [jekyll-gist][jekyll-gist] | Liquid tag for displaying GitHub Gists in Jekyll sites. | -| [jekyll-feed][jekyll-feed] | A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts. | -| [jemoji][jemoji] | GitHub-flavored emoji plugin for Jekyll. | +| Plugin | Description | +| --- | --- | +| [jekyll-paginate][jekyll-paginate] | Pagination Generator for Jekyll. | +| [jekyll-sitemap][jekyll-sitemap] | Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site. | +| [jekyll-gist][jekyll-gist] | Liquid tag for displaying GitHub Gists in Jekyll sites. | +| [jekyll-feed][jekyll-feed] | A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts. | +| [jemoji][jemoji] | GitHub-flavored emoji plugin for Jekyll. | +| [jekyll-include-cache][jekyll-include-cache] | Liquid tag that caches Liquid includes. | [jekyll-paginate]: https://github.com/jekyll/jekyll-paginate [jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap [jekyll-gist]: https://github.com/jekyll/jekyll-gist [jekyll-feed]: https://github.com/jekyll/jekyll-feed [jemoji]: https://github.com/jekyll/jemoji +[jekyll-include-cache]: https://github.com/benbalter/jekyll-include-cache If you're hosting elsewhere then you don't really have to worry about what is whitelisted as you are free to include whatever [Jekyll plugins](https://jekyllrb.com/docs/plugins/) you desire. +**Note:** The [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin needs 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. +{: .notice--warning} + ## Archive Settings The theme ships with support for taxonomy (category and tag) pages. GitHub Pages hosted sites need to use a _Liquid only_ approach while those hosted elsewhere can use plugins like [**jekyll-archives**][jekyll-archives] to generate these pages automatically. diff --git a/docs/_docs/18-history.md b/docs/_docs/18-history.md index 990e4489..79e23bc7 100644 --- a/docs/_docs/18-history.md +++ b/docs/_docs/18-history.md @@ -4,7 +4,7 @@ permalink: /docs/history/ excerpt: "Change log of enhancements and bug fixes made to the theme." sidebar: nav: docs -last_modified_at: 2018-10-04T15:41:33-04:00 +last_modified_at: 2018-10-04T20:16:47-04:00 toc: true --- @@ -12,7 +12,7 @@ toc: true ### 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] - 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)