Ваш первый плагин

Плагины позволяют расширить функциональность Jekyll в соответствии с вашими потребностями. Существует шесть типов плагинов в Jekyll.

Генераторы

Генераторы создают контент на вашем сайте. Например:

jekyll-feed создаёт ленту Atom для постов блога.
jekyll-archives создаёт страницы архивов для категорий и тегов блога.
jekyll-sitemap создаёт карту сайта.

Конвертеры

Конвертеры изменяют язык разметки на другой формат. Например:

jekyll-textile-converter конвертирует textile в HTML.
jekyll-coffeescript конвертирует Coffeescript в JavaScript.
jekyll-opal конвертирует Ruby в JavaScript.

Команды

Команды расширяют исполняемый файл jekyll с помощью подкоманд. Например:

jekyll-compose добавляет подкоманды для создания поста, страницы или черновика.

Фильтры

Фильтры создают пользовательские фильтры Liquid. Например:

jekyll-time-ago - Расстояние между двумя датами словами.
jekyll-toc - Генерирует таблицу содержания.
jekyll-email-protect - Замаскирует электронные письма, чтобы защитить их от спам-ботов.

Обработчики

Обработчики предоставляют тонкую настройку для расширения процесса сборки. Например:

jemoji Отображение эмодзи
jekyll-mentions преобразует упоминания @jekyll в ссылки
jekyll-spaceship - расширенный пример. Предоставляет мощную поддержку таблиц, mathjax, plantuml, видео и т. д.

Флаги

При написании плагина следует учитывать два флага:

Флаг Описание

Флаг	Описание
`safe`	Логический флаг, который сообщает Jekyll, может ли этот плагин безопасно выполняться в среде, где запрещено произвольное выполнение кода. Это используется GitHub Pages для определения, какие основные плагины могут использоваться, а какие небезопасны для выполнения. Если ваш плагин не допускает произвольного выполнения кода, установите это значение в `true`. GitHub Pages всё равно не загрузит ваш плагин, но если вы отправите его для включения в ядро, лучше это сделать правильно!
`priority`	Этот флаг определяет порядок загрузки плагина. Допустимые значения: `:lowest`, `:low`, `:normal`, `:high`, и `:highest`. Плагины с более высоким приоритетом применяются первыми, а с более низким — последними.

safe

Логический флаг, который сообщает Jekyll, может ли этот плагин безопасно выполняться в среде, где запрещено произвольное выполнение кода. Это используется GitHub Pages для определения, какие основные плагины могут использоваться, а какие небезопасны для выполнения. Если ваш плагин не допускает произвольного выполнения кода, установите это значение в true. GitHub Pages всё равно не загрузит ваш плагин, но если вы отправите его для включения в ядро, лучше это сделать правильно!

priority

Этот флаг определяет порядок загрузки плагина. Допустимые значения: :lowest, :low, :normal, :high, и :highest. Плагины с более высоким приоритетом применяются первыми, а с более низким — последними.

Чтобы использовать один из примеров плагинов выше в качестве иллюстрации, вот как вы бы указали эти два флага:

module Jekyll
  class UpcaseConverter < Converter
    safe true
    priority :low
    ...
  end
end