search

apsislabs / jekyll-tidy

A gem for tidying Jekyll HTML output
MIT License
42 stars 5 forks source link

'gems' is deprecated, use 'plugins' #15

Closed mscoutermarsh closed 5 years ago

mscoutermarsh commented 7 years ago

Hello!

Received this deprecation notice today when following the installation instructions.

Deprecation: The 'gems' configuration option has been renamed to 'plugins'. Please update your config file accordingly.

Updated the docs to reflect new name.

ashmaroli commented 7 years ago

Note: plugins: will only work as intended for Jekyll 3.5 and above. On older versions, using plugins: will throw another unrelated warning notice. And jekyll-tidy is compatible with all versions of Jekyll in the 3.x.x series.

So IMO, the documentation should be broad enough to cater across the range of versions.

ashmaroli commented 7 years ago

IMO, a simple addition to the sentence might suffice:


- You can also include the plugin using the `gems` option in your `_config.yml` file, like so:
+ You can also include the plugin using the `gems` option (or `plugins`, if you're on Jekyll 3.5
+ and above), in your `_config.yml` file, like so: