Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package-ify this template? #118

Closed
vincerubinetti opened this issue Jun 4, 2022 · 3 comments
Closed

Package-ify this template? #118

vincerubinetti opened this issue Jun 4, 2022 · 3 comments
Labels
enhancement New feature or request question Further information is requested

Comments

@vincerubinetti
Copy link
Collaborator

vincerubinetti commented Jun 4, 2022

There are a few high-level frustrations with this template that I wish I could improve:

  1. It is very hard and cumbersome to update a website to the latest version of the template, even for me who knows every file and line of code intimately. Perhaps this is less of a problem as the template becomes more stable and changes less, thus avoiding the need to update. It's also hard to know what version of the template you're on. If the template were, for example, simply a package you install in your Gem (Ruby) package file, with a SemVer number, it'd be easier to get users to stay up to date, and easier to troubleshoot problems.
  2. Everything in the template is exposed to the user. I'd guess that 75% or more of the files and code could be called "under-the-hood", code that most users would never need to edit. This is good for power users who want to customize things, but is just a source of complexity, confusion, and most importantly distraction for users who just want to focus on their website content (most of our audience?).

I'm not exactly sure what the solution would be, but my instinct is that the template would be a Gem (Ruby package), and would "hide" as much of its code in there as possible. A user would then just install the package in a blank Jekyll site (we would still give instructions), or we could keep a very minimal Jekyll boilerplate repo with the package already installed.


But before pursuing this, I'd like to know what users want. If you're a user reading this, please vote:

  • 👍 I want things as simple as possible so I can focus just on my website content. I don't care about customizing deep functionality of the template, I just need some very basic surface-level customization. I want to be able to easily update my version of the template when new features and bug fixes come out.
  • 👎 I want absolute control. I want to be able to change any line of code in the template, including things like: the behavior of auto-citations, the exact look and feel of components (beyond high-level "theming"), etc. It is okay that updating my version of the template for new features and bug fixes will be difficult.
@vincerubinetti vincerubinetti added the enhancement New feature or request label Jun 4, 2022
@williamsdrake
Copy link

Probably in the minority but 👎

@vincerubinetti vincerubinetti added the question Further information is requested label Jul 15, 2022
@vincerubinetti
Copy link
Collaborator Author

Realistically, I don't think this is something that will be possible. I don't think Jekyll is really set up to do this cleanly. Perhaps other SSGs would be.

@vincerubinetti vincerubinetti closed this as not planned Won't fix, can't repro, duplicate, stale Feb 7, 2023
@vincerubinetti
Copy link
Collaborator Author

Related: #278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants