Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Plugins

okeeblow edited this page · 149 revisions

The Jekyll plugin system hooks allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.

Installing a plugin

In your site source root, make a _plugins directory. Place your plugins here. Any file ending in *.rb inside this directory will be required when Jekyll generates your site.

In general, plugins you make will fall into one of three categories:

1. Generators
2. Converters
3. Tags

Generators

You can create a generator when you need Jekyll to create additional content based on your own rules. For example, a generator might look like this:

module Jekyll

  class CategoryIndex < Page
    def initialize(site, base, dir, category)
      @site = site
      @base = base
      @dir = dir
      @name = 'index.html'

      self.process(@name)
      self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
      self.data['category'] = category

      category_title_prefix = site.config['category_title_prefix'] || 'Category: '
      self.data['title'] = "#{category_title_prefix}#{category}"
    end
  end

  class CategoryGenerator < Generator
    safe true
    
    def generate(site)
      if site.layouts.key? 'category_index'
        dir = site.config['category_dir'] || 'categories'
        site.categories.keys.each do |category|
          write_category_index(site, File.join(dir, category), category)
        end
      end
    end
  
    def write_category_index(site, dir, category)
      index = CategoryIndex.new(site, site.source, dir, category)
      index.render(site.layouts, site.site_payload)
      index.write(site.dest)
      site.pages << index
    end
  end

end

In this example, our generator will create a series of files under the `categories` directory for each category, listing the posts in each category using the `category_index.html` layout.

Generators are only required to implement one method:

1. generate: string output of the content being generated

Converters

If you have a new markup language you’d like to include in your site, you can include it by implementing your own converter. Both the markdown and textile markup languages are implemented using this method. Please note that Jekyll will only convert files that also have a YAML header at the top. If there is no YAML header at the top of the file, Jekyll will ignore it and not send it through the converter.

Below is a converter that will take all posts ending in .upcase and process them using the UpcaseConverter:

module Jekyll
  class UpcaseConverter < Converter
    safe true

    priority :low

    def matches(ext)
      ext =~ /upcase/i
    end 

    def output_ext(ext)
      ".html"
    end

    def convert(content)
      content.upcase
    end
  end
end

Converters should implement at a minimum 3 methods:

1. matches: Called to determine whether the specific converter will run on the page.
2. output_ext: The extension of the outputted file, usually “.html”
3. convert: Logic to do the content conversion

In our example, UpcaseConverter#matches checks if our filename ends in the word ‘upcase’, and will render using the converter if it does. It will call UpcaseConverter#convert to process the content – in our simple converter we’re simply capitalizing the entire content string. Finally, when it saves the page, it will do so with the .html extension.

Tags

If you’d like to include custom liquid tags in your site, you can do so by hooking into the tagging system. Built-in examples from jekyll include the ‘highlight’ and the ‘include’ tag.

As an example, here is a custom liquid tag that will output the time the page was rendered:

module Jekyll
  class RenderTimeTag < Liquid::Tag

    def initialize(tag_name, text, tokens)
      super
      @text = text
    end

    def render(context)
      "#{@text} #{Time.now}"
    end
  end
end

Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)

At a minimum, liquid tags must implement:

1. render: Outputs the content of the tag

You must also register the custom liquid tag with the Liquid templating system by calling:

Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)

In the example above, we can place the following tag anywhere in one of our pages:

{% render_time page rendered at: %}

And we would get something like this on the page:

page rendered at: Tue June 22 23:38:47 -0500 2010

Liquid filters

You can add your own filters to the liquid system much like you can add tags above. Filters are simply modules that export their methods to liquid. All methods will have to take at least one parameter which represents the input of the filter. The return value will be the output of the filter.

module Jekyll
  module AssetFilter
    def asset_url(input)      
      "http://www.example.com/#{input}?#{Time.now.to_i}"
    end
  end
end

Liquid::Template.register_filter(Jekyll::AssetFilter)

Advanced: you can access the site object through the @context.registers feature of liquid. Registers a hash where arbitrary context objects can be attached to. In Jekyll you can access the site object through registers. As an example, you can access the global configuration (_config.yml) like this: @context.registers[:site].config['cdn'].

Flags

There are two flags to be aware of when writing a plugin:

1. safe: boolean that allows a plugin to be safely included in jekyll core for exclusion from use with GitHub pages. In general, set this to true.
2. priority: determines what order the plugin is loaded in. Valid values are: :lowest, :low, :normal, :high, :highest

Available Plugins

There are a few useful, prebuilt plugins at the following locations:

  1. Truncate HTML while preserving markup structure by Matt Hall
  2. Generic Blog Plugins by Jose Diaz-Gonzalez : Contains plugins for tags, categories, archives, as well as a few liquid extensions
  3. Domain Name Filter by Lawrence Woodman : Filters the input text so that just the domain name is left
  4. Jekyll Plugins by Recursive Design : Plugin to generate Project pages from github readmes, a Category page plugin, and a Sitemap generator
  5. Tag Cloud Plugin from a Jekyll walk-through : Plugin to generate a Tag Cloud
  6. Pygments Cache Path by Raimonds Simanovskis : Plugin to cache syntax-highlighted code from Pygments
  7. Delicious Plugin by Christian Hellsten : Fetches and renders bookmarks from delicious.com.
  8. Ultraviolet plugin by Steve Alex : Jekyll Plugin for Ultraviolet
  9. HAML plugin by Sam Z : HAML plugin for jekyll
  10. ArchiveGenerator by Ilkka Laukkanen : Uses this archive page to generate archives
  11. Tag Cloud Plugin by Ilkka Laukkanen : Jekyll tag cloud / tag pages plugin
  12. HAML/SASS Converter by Adam Pearson : Simple haml-sass conversion for jekyll. Fork by Sam X
  13. SASS scss Converter by Mark Wolfe : Jekyll Converter which uses the new css compatible syntax, based on the one written by Sam X.
  14. GIT Tag by Alexandre Girard : Jekyll plugin to add Git activity inside a list
  15. Draft/Publish Plugin by Michael Ivey
  16. Less.js generator by Andy Fowler : Jekyll plugin to render less.js files during generation.
  17. Less Converter by Jason Graham : A Jekyll plugin to convert a .less file to .css
  18. Less Converter by Josh Brown
  19. Less Converter by Aggelos Orfanakos : Jekyll plugin for converting less files with node.js and less.js
  20. MathJax Liquid Tags by Jessy Cowan-Sharp : A simple liquid tag for Jekyll that converts {% m } and { em } into inline math, and { math } and { endmath %} into block equations, by replacing with the appropriate MathJax script tags.
  21. Non-JS Gist Tag by Brandon Tilley A Liquid tag for Jekyll sites that allows embedding Gists and showing code for non-JavaScript enabled browsers and readers.
  22. Growl Notification Generator by Tate Johnson
  23. Growl Notification Hook by Tate Johnson : Better alternative to the above, but requires his “hook” fork.
  24. Version Reporter by Blake Smith
  25. Upcase Converter by Blake Smith
  26. Render Time Tag by Blake Smith
  27. Summarize Filter by Mathieu Arnold
  28. Status.net/OStatus Tag by phaer
  29. CoffeeScript converter by phaer : Put this file in _plugins/ and write a YAML header to your .coffee files (i.e. “-\n—-\n”). See http://coffeescript.org for more info
  30. Raw Tag by phaer. : Keeps liquid from parsing text betweeen {% raw } and { endraw %}
  31. URL encoding by James An
  32. Sitemap.xml Generator by Michael Levin
  33. Markdown references by Olov Lassus : Keep all your markdown reference-style link definitions in one file (_references.md)
  34. Full-text search by Pascal Widdershoven : Add full-text search to your Jekyll site with this plugin and a bit of JavaScript.
  35. Stylus Converter Convert .styl to .css.
  36. Embed.ly client by Robert Böhnke Autogenerate embeds from URLs using oEmbed.
  37. Tag Cloud (Source) : Flexible. Logarithmic distribution. Usage eg: {% tag_cloud font-size: 50 – 150%, threshold: 2 %}.
  38. Related Posts by Lawrence Woodman : Overrides site.related_posts to use categories to assess relationship
  39. AliasGenerator by Thomas Mango : Generates redirect pages for posts when an alias configuration is specified in the YAML Front Matter.
  40. FlickrSetTag by Thomas Mango : Generates image galleries from Flickr sets.
  41. Projectlist by Frederic Hemberger : Loads all files from a directory and renders the entries into a single page, instead of creating separate posts.
  42. Tiered Archives by Eli Naeher : creates a tiered template variable that allows you to create archives grouped by year and month.
  43. Jammit generator by Vladimir Andrijevik : enables use of Jammit for JavaScript and CSS packaging.
  44. oEmbed Tag by Tammo van Lessen : enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
  45. Company website and blog plugins by Flatterline, a Ruby on Rails development company : portfolio/project page generator, team/individual page generator, author bio liquid template tag for use on posts and a few other smaller plugins.
  46. Transform Layouts Monkey patching allowing HAML layouts (you need a HAML Converter plugin for this to work)
  47. ReStructuredText converter : Converts ReST documents to HTML with Pygments syntax highlighting.
  48. Tweet Tag by Scott W. Bradley : Liquid tag for Embedded Tweets using Twitter’s shortcodes
  49. jekyll-localization : Jekyll plugin that adds localization features to the rendering engine.
  50. jekyll-rendering : Jekyll plugin to provide alternative rendering engines.
  51. jekyll-pagination : Jekyll plugin to extend the pagination generator.
  52. jekyll-tagging : Jekyll plugin to automatically generate a tag cloud and tag pages.
  53. Generate YouTube Embed by joelverhagen : Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
  54. JSON Filter by joelverhagen : filter that takes input text and outputs it as JSON. Great for rendering JavaScript.
  55. jekyll-beastiepress : FreeBSD utility tags for Jekyll sites.
Something went wrong with that request. Please try again.