hyas icon indicating copy to clipboard operation
hyas copied to clipboard

Documentation request

Open pensivedog opened this issue 3 years ago • 2 comments

The standard Hugo setup includes a themes/ folder and allows for specifying theme components, as described here. This makes it easy to have an updateable base theme and simply include customizations as overrides in a sub/child theme.

  • Is it possible to use hyas or hyas-child-theme as described above?
  • Or, is it possible to use hyas but add a themes/ directory that allows for overriding/customizing some components, while keeping hyas updateable (I guess by excluding config/_default/config.toml and content/ and themes/ from updates)?
  • How does hyas-child-theme differ from hyas and how should this be used?

I'm looking for an intuitive way to do build a site with hyas, adding my own style and layout customizations, while being able to easily update the hyas base code in the future. Any guidance on this is greatly appreciated.

pensivedog avatar Jul 04 '22 09:07 pensivedog

Please see https://github.com/h-enk/hyas/discussions/311#discussioncomment-3075756 + https://github.com/h-enk/hyas/issues/312

So, in short:

  • No (unfortunately not)
  • Don't know (haven't tested it — I think so, but needs a POC)
  • The hyas-child-theme holds Hyas as an npm package. It's intended for minor customizations, and allows you to easily update npm packages — including Hyas itself. Note though (see the issues linked to above), that I'm planning to drop the child theme for the restructured starter theme (which will then allow you to update Hyas)

h-enk avatar Jul 04 '22 10:07 h-enk

Great, thank you for the reply and your work on this. Looking forward to the restructured starter theme.

pensivedog avatar Jul 04 '22 10:07 pensivedog