0.0
No commit activity in last 3 years
No release in over 3 years
Prepare Jekyll page data using Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.6
~> 2.5
~> 10.0
 Project Readme

Jekyll::Prep

Prepare Jekyll page data using Ruby.

Installation

See Jekyll's documentation for installing Jekyll plugins.

Usage

  1. Create a _prep directory in your Jekyll project.
  2. Inside the _prep directory, create .rb files that correspond to your .md Jekyll pages. For example, if you have a /people/jill.md Jekyll page then create a _prep/people/jill.rb file.
  3. Inside the .rb files, define subclasses of Jekyll::Prep::Script that define a prepare method that will receive an instance of Jekyll::Page. The subclass namespaces must align with the .rb file paths minus the leading underscore. For example, the file _prep/people/jill.rb should contain Prep::People::Jill.
  4. Inside the prepare methods, do whatever you want to page.data.
# _prep/people/jill.rb

module Prep
  module People
    class Jill < Jekyll::Prep::Script

      def prepare(page)
        page.data['something new'] = 'was added during prep'
      end

    end
  end
end

Contributing

  1. Fork it (https://github.com/gregoryjscott/jekyll-prep/fork).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create a new Pull Request.