getindiekit / indiekit

The little Node.js server with all the parts needed to publish content to your personal website and share it on social networks.
https://getindiekit.com
MIT License
327 stars 34 forks source link

Recommended preset for Eleventy-based site? #554

Closed sentience closed 1 year ago

sentience commented 1 year ago

What part of the documentation isn’t clear?

Core concepts

How could the documentation be improved?

When getting Indiekit set up for the first time, I was uncertain whether to select the Jekyll publication preset for my Eleventy site that is set up with Jekyll-like directory structure, or to go without a publication preset. Having read the source code of the Jekyll preset, I now believe that using this preset is my best bet.

I suggest the documentation could be clearer about the fact that the Jekyll preset is appropriate for use with Jekyll-like site generators like Eleventy.

paulrobertlloyd commented 1 year ago

Good idea! I’ve been meaning to add an 11ty preset, but it doesn’t deviate from Jekyll enough from a data format perspective to make it worth doing, besides having the correct name. I’ll update the docs.

paulrobertlloyd commented 1 year ago

Added Eleventy and Lume to the descriptions of the Jekyll plugin, both in its README.md and its description in the plugin-directory. Also added 11ty, eleventy and lume tags to the plug-ins package.json to help with discovery.

The mention of the Jekyll preset on the core concepts page was incorrect, as the example then showed the Hugo preset 🤦🏼‍♂️