Feature: conversion of theme to hugo module (#147)

deining commented 1 year ago

Following up in #147, this PR converts the theme into a hugo module and automatically pulls in bulma as dependency.

With this PR in place, setting up a new site based on shadocs can be done via:

hugo new site my-site
cd my-site
hugo mod init github.com/me/my-site
hugo mod get github.com/jgazeau/shadocs #optional
echo 'theme = "github.com/jgazeau/shadocs" >> config.toml
hugo server

With this PR applied, you can preview the exampleSite simply via hugo server (no bulma submodule checkout and themesDir=../.. needed any more).

Notes:

deploy on netlify and other checks fail currently. This is to be expected since we have a chicken - egg problem here. Once this PR is merged, checkers should go green again
if you follow this route, your future tags/releases should have the form v1.3.0 (note the leading v), since this conforms to go`s naming convention for go modules.
if you want to continue to provide a zip-archive, you should issue hugo mod vendor at the command prompt. This creates a directory _vendor containing the theme module sources (incl. bulma dependency).
Updating the theme is super easy now: hugo mod get -u github.com/jgazeau/shadocs@v1.3.0. That's it!
Same for updating bulma within the theme itself: hugo mod get -u github.com/jhthms/bulma@0.9.5
I did intentionally small commits, we can squash them into one when merging this PR.

I hope you like my PR. With this PR in place, we have the foundation to get some goodies added to your theme, I have something in mind here.

This PR closes #147.

jgazeau commented 1 year ago

Hi @deining ,

Thanks for your PR,

Indeed seems totally relevant and useful. I'll try to have a look at it asap, but I'll be quite busy in the next few weeks, so don't expect it to be merged soon.

deining commented 1 year ago

Hi @deining ,

Thanks for your PR,

You are welcome.

Indeed seems totally relevant and useful.

Great you like it.

I'll try to have a look at it asap, but I'll be quite busy in the next few weeks, so don't expect it to be merged soon.

Take your time, that's fine for me.

After yesterday's rework of the .saas files, I have to rebase this PR. In that context, I tried to break down that PR into pieces, starting with #158. I hope this PR can be merged soon. Thanks for reviewing this PR.

ShaunaGordon commented 2 months ago

Hey @jgazeau, I just found this theme, but not being a Hugo module is kind of a non-starter for me. Is there something in particular that's kept this from getting merged?

jgazeau commented 2 months ago

Hi @ShaunaGordon , sorry didn't have a lot of time to dig into it. Just want to make sure I understand everything about hugo modules and also the impact on current users before merging it. I'll try to take this as soon as I can

jgazeau / shadocs

Feature: conversion of theme to hugo module (#147) #149