Skip to content

OpenAddressesUK/jekylly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jekylly

Jekylly allows you to use a Jekyll-style site layout, including data and posts, to manage static content in a rails app.

We've tried to remain as close to Jekyll as possible, though you use ERB instead of Liquid, and layouts are handled by Rails.

Supported Jekyll Features

  • Data files
  • Posts (including in categories)
  • YAML Frontmatter, including titles and layouts
  • Includes (though you need to add an underscore to the filenames)

Things we've not done properly yet

  • Only supports "pretty" permalink style.
  • Tests. This grew out of an off-the-cuff experiment, so.
  • Loads of other things probably.

Usage

More docs to come, but the basics are:

Gemfile:

gem 'jekylly', github: 'OpenAddressesUK/jekylly'

routes.rb

Rails.application.routes.draw do

  # all your other routes first

  mount Jekylly::Engine, at: "/path/to/static/content" # you can use '/' if you want
  
end

If you want to use Jekylly to manage your root page, you can do this:

root to: 'jekylly/static#show', defaults: { path: 'your_page' }

Assets and layouts go in the Rails app as usual. Jekyll site content goes into app/views/static

About

A rails engine for rendering Jekyll-like pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published