I’m the author of a Jekyll theme (Beautiful Jekyll) that is available to be installed as a gem and as a GitHub Pages theme.
I recently found out that jekyll can also be run on Windows, and on the documentation page it says that for Windows we need to add the tzinfo
and tzinfo-data
gems to the Gemfile.
My question is: since my theme is not only used by me on my own environment but it’s also published as a gem and installable by other people, do I need to add these timezone gems to the gemspec?
After a few days of research, I think I understand this better and I believe this is the answer. I would appreciate confirmation.
The issue came from the fact that on Windows the tzinfo
and tzinfo-data
gems are needed, and the official Jekyll docs say to add a few lines to the Gemfile for that. My question was whether, as a theme author, I need to also update the gemspec to allow for Windows users to use my theme.
The answer is NO.
Only the Gemfile needs to be modified. This is because the issue only arrises if someone directly clones the git repository for my theme and tries to run it on Windows. The Gemfile needs to be updated so that the timezone gems will be included in that case. However, for anyone who installs the theme by calling jekyll new
and then using the gem, this is not needed because jekyll new
automatically adds these gems to the Gemfile. This has been the case for several years, as can be seen here