vwochnik / jekyll-email-protect

Email protection liquid filter for Jekyll
MIT License
87 stars 11 forks source link

Installation instruction problem in README #12

Open pymaldebaran opened 3 years ago

pymaldebaran commented 3 years ago

The README instructions to install the plusgin into our jekyll project are:

After the plugin has been installed successfully, add the following lines to your _config.yml in order to tell Jekyll to use the plugin:

gems:
- jekyll-email-protect

With this config, the filter seems to have no effect at all.

But after trying different things the only way to make the plugin work was to instead put this in the _config.yml:

plugins:
- jekyll-email-protect

Maybe since the last update of the plugins, the jekyll config syntax changed ?

architchandra commented 3 years ago

Looks like the name of the setting changed (gems -> plugins) in Jekyll's v3.5. https://jekyllrb.com/docs/plugins/installation/