Explanations and Examples of Jekyll Plugins

submited by
Style Pass
2022-06-21 22:30:09

This blog post discusses the various types of Jekyll plugins, including filters, generators, tags, block tags and hooks. It is intended to provide background information.

The follow-on blog post builds upon the information presented here. It discusses a GitHub project that provides many working examples of plugins that you can use as a starting point for your own plugins.

Jekyll supports the following types of plugins. This blog post discusses and demonstrates templates for all of these types of plugins.

The official Jekyll documentation does not provide much guidance about how to debug Jekyll plugins. Please read my blog post on Debugging Jekyll Plugins. In this post, and the follow-on post, I provide debugging scripts for the plugins shown. You can use those scripts on your Jekyll plugin projects.

Block tag and inline tag plugins often require parameter parsing. I have never seen good parameter parsing for Jekyll tag plugins. Most tag plugins either have no need to pass arguments, or the parameters are merely keywords (which are easy to parse), or Yet Another Awful Parser (YAAP) is built.

Leave a Comment