Plugin: jekyll-data

[ashmaroli]

Hello Richard, I'm the author of a Jekyll Plugin called jekyll-data. It basically reads data files within _data and a _config.yml within the theme gem.

I plan to release a v1.0 in the near future and am looking for theme-gems that may benefit from my plugin.

From the README, I gather that this plugin will indeed be helpful to your theme's casual users.

When using the plugin,

• you can include the _data/links.yml in the gem and it will be picked up by Jekyll.
• you can include a _config.yml with the required fields pre-populated and that will be picked up by Jekyll as well.

For a new user starting with the jekyll new command, all they'd have to do is add this plugin to their Gemfile. At minimum, their Gemfile just needs to be:

gem "jekyll-theme-perry"

group :jekyll_plugins do
  gem "jekyll-data", git: "https://github.com/ashmaroli/jekyll-data.git"
end

and their _config.yml to be (at minimum):

theme: jekyll-theme-perry

# comment out the gems array. The plugins required by the theme will
# be run from within the gem itself.
# If you wish to include another plugin, please include it in the Gemfile
# gems:
#   - jekyll-feed

Then, if your theme-gem has the necessary data file and proper _config.yml included within it, the user is all set by simply running:

$ bundle install
$ bundle exec jekyll serve

Note: The downside being that the user will have to have those two files at the source to customize the pre-configured keys, nevertheless.

[richardp2]

This is definitely an interesting idea for use on my own site, but I'm not sure about how this would work in the wild given different sites will have different navigation links and different authors, but it is something that I will have a look at.

Thank you 😃