daattali / beautiful-jekyll

✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
https://beautifuljekyll.com
MIT License
5.39k stars 16.27k forks source link

release new gem version #243

Closed daattali closed 4 years ago

daattali commented 7 years ago

as mentioned in #237

daattali commented 7 years ago

I've decided to stop supporting the Ruby gem because it has too many issues. It requires a lot more work from the user than simply cloning/forking the git repo, it requires a lot more work from me to maintain two branches with similar features, and it's less flexible and harder to use. There are also issues, for example the default jekyll site built with jekyll new has an aboutme page that searches for a file icon-github.html which doesn't exist in my theme, so that causes an error.

If anyone wants to use beautiful-jekyll, I highly suggest forking from the main repo rather than using the gem

ohadschn commented 7 years ago

Note that gem-based themes are the recommended Jekyll theme type. They might lack built-in GH pages support, but making them work using external CI (like Travis) shouldn't be too much of an issue. In addition, gem-based themes are actually supported out of the box on GitLab pages, and I think a few other places like Netlify.

The problem with fork-based theming is the lack of a good update story. You have to deal with multiple remotes and 3-way merging, a real pain compared to bundle install. BTW, what do you mean by having to maintain two separate branches?

daattali commented 7 years ago

what do you mean by having to maintain two separate branches?

Every change that happens to the main branch needs to be merged into here.

You bring up good points, but I simply don't know enough ruby and jekyll to deal with this on my free time. I only made the gem initially because I wanted to experiment with it for fun, and I'm happy there is a version for it, but it's not something I can afford to maintain (at least until I decide to invest a bit more time into getting experience with ruby/gems, because right now I spend way too much time googling errors every time I try to do anything).

I personally don't use it so it was hard for me to see that it's useful. The fact that running jekyll new and then using this theme results in an error really put me off - is that not a big deal for people who use jekyll gems?

ohadschn commented 7 years ago

Hey, that's fair enough. I don't think jekyll new is much of a factor though as most people could just start off by forking your repo (or some blank sample repo like https://gitlab.com/pages/jekyll and copy index.html and _config.yml).

Regarding a separate branch, I'm still not sure why you'd keep a separate branch for the gem. Why not keep the gemspec on master? Anyway, if you ever decide to invest a little more in this, I can recommend minimial-mistakes as a reference. The owner looks like he knows what he's doing, and he maintains an up to date gem (which is what I'm currently using for my blog).

daattali commented 7 years ago

Ohad, thanks for your discussion, I'll reopen this. I may be wrong about this, but I do think 2 branches are necessary since they don't contain identical code. The master branch is specifically tailored for github pages, and the gem branch has a different structure, different readme, and slightly different files. But again, my knowledge of gems is extremely limited so maybe there is a better way to do it.

ohadschn commented 7 years ago

Sure thing Dean, thanks for listening. I am far from a gem expert myself but I do believe Minimal Mistakes only has a master branch and his theme is both GH-pages ready and gem-enabled. You can take a look at his gemspec, maybe it'll give you some ideas. He is also extremely responsive and helpful, you could open an issue on his tracker asking him about it and I'm sure he'll give you a good answer.

daattali commented 7 years ago

Yep he does indeed have just one branch. I chose to use a different branch so that I wouldn't have to change the file structure (moving all the assets into assets/) and so that the README would be specific for github users on master, and to ruby gem users on the gem version. Maybe it's not worth the hassle of keeping them separate only for that though :)

ohadschn commented 7 years ago

IMHO, Definitely not worth the hassle :)

BTW, personally I would recommend everyone to use GitLab pages with out of the box support for gem-based themes - it works great!

daattali commented 7 years ago

Perhaps. I'm currently still a github fanboy. And this theme was created with the intent of being focused on people who want to create github pages, that's still how I try to keep it. I might reconsider later. You've done enough convincing for today, maybe try again tomorrow :) layla tov

On Sep 12, 2017 18:25, "Ohad Schneider" notifications@github.com wrote:

IMHO, Definitely not worth the hassle :)

BTW, personally I would recommend everyone to use GitLab pages with out of the box support for gem-based themes - it works great!

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/daattali/beautiful-jekyll/issues/243#issuecomment-329001628, or mute the thread https://github.com/notifications/unsubscribe-auth/AA6IFAGNMiMxY5t4FIK3lO75PmFw6zWuks5shwS9gaJpZM4PLXCb .