search

benbalter / jekyll-remote-theme

Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
MIT License
291 stars 78 forks source link

Make error output for themes that are not remote_theme compliant more verbose #82

Closed ScottA38 closed 4 years ago

ScottA38 commented 4 years ago

Problem:

I am trying to use an existing theme desiredpersona/jekyll-theme-jam as a theme on Github pages. When I try and use it I get an error that: Remote Theme: "jekyll-theme-jam" is not a valid remote theme, this is fine but if I want to fork and fix the theme or adapt it from a gem style, I have no previous experience with Ruby or Jekyll so I have no idea what to modify to make it work

Describe the solution you'd like

Detailed information about what in the remote_theme 'munging' (is that right?) failed - was the repository found? Is it an incorrect file system?

Maybe this could also be saved to a log file, but I don't know how you could flag this to Jekyll

Describe alternatives you've considered

A specification on the README of this repository as to what constitutes a remote_theme compliant theme looks like would also be fine for me and I would see as viable alternative

Both the README here and other places cite the Jekyll docs but I am none the wiser after reading this - to me I don't see what's wrong with this theme

ScottA38 commented 4 years ago

Just as an update to this issue, I believe I got this error because I did not remove the commenting from the github-pages gem after running bundler exec jekyll [version] new, as I did not need to make changes to the repo, after doing so it was accepted as valid.

I do, however, think that if it is possible showing exactly what is wrong would be useful if a theme is not valid

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.