Best Practice Improvements

[mnordhaus]

While I on my own Website using the theme I figured some points that might help - utilize Best Practices:

Better harness the template lookup order and especially use the baseof template

Hugo has a very powerful way using a Lookup Order for Templates. The theme does not use the baseof template at the moment.
It might also be helpful to use render hooks and content views
https://gohugo.io/templates/lookup-order/
https://gohugo.io/templates/base/
https://gohugo.io/templates/types/

Do not use i18n for content - Cleary distinguish

The theme has a lot of what I would consider Content within i18n files. From my point of view it would be better to move that into the Content folder (en / de / es / ...). Example:

## Homepage head title
- id: "head_title"
  translation: "Demo site for Adritian - a high performance hugo theme by Adrián Moreno"

- id: "head_description"
  translation: "This hugo theme (Adritian) is based on Bootstrap and has features that make it suitable for a personal site, a portfolio or other kind of Single Page Applications."

Landingpage CMS friendly

Put sections for a landingpage (like the Homepage, that is something to be generalized IMHO) in a page file like that:

sections:
  - template: showcase
     metafield1: matavalue1
     mefafield2: metavalue2
     ...
     metafieldN: metavalueN
     content:
      ... individual set of fields for the section type
  - template: about
     metafield1: matavalue1
     mefafield2: metavalue2
     ...
     metafieldN: metavalueN
     content:
      ... individual set of fields for the section type

Bootstrap / Sass Best Practices

-> https://www.hugolify.io/docs/getting-started/best-practices/

Removing the Example Content out of the theme and bundle it with the "all batteries included asset" later on

It feels a little bit odd to have the example content available in the theme (including assets and images not within the example folder) when using it as a module. The content is obscure and might accidentally interfere with content of the production website.

On the other hand it is good to have examples available. I guess a good idea is to treat that the same as the bootstrap dependencies.

[zetxek]

Thanks for the ideas for improvement @mnordhaus :)

As the theme itself was a "spin-off" my own website and the original theme i started using, the content hierarchy is a bit murky still. It mixes content in data and i18n - would be good to harmonize it, to know where to find and define things.

🤔 And now that you mention, I believe that some of the missing theme lookup is what is causing me some trouble in the CV generation - as some of the templates I create still give a 404.

For the sample content - I'd still like to find a good way to provide a kickstart instead of having to copy paste a lot of stuff.
Even on the tests I'm downloading content from the repo (https://github.com/zetxek/adritian-free-hugo-theme/blame/main/.github/workflows/test-module-init.yml#L35)

Maybe a npm package would be a good solution, as it can even be distributed in the theme package.hugo.json...

Thanks for the input and suggestions - PRs are welcome! They will make the theme better 😃

[mnordhaus]

I like the Kickstart Idea too, but that could be an extra repo - a github template where everything is preconfigured. That gives the fastest Kickstart. Am So., 2. Feb. 2025 um 14:57 Uhr schrieb Adrián Moreno Peña < ***@***.***>:

…

Thanks for the ideas for improvement @mnordhaus <https://github.com/mnordhaus> :) As the theme itself was a "spin-off" my own website and the original theme i started using, the content hierarchy is a bit murky still. It mixes content in data and i18n - would be good to harmonize it, to know where to find and define things. 🤔 And now that you mention, I believe that some of the missing theme lookup is what is causing me some trouble in the CV generation - as some of the templates I create still give a 404. For the sample content - I'd still like to find a good way to provide a kickstart instead of having to copy paste a lot of stuff. Even on the tests I'm downloading content from the repo ( https://github.com/zetxek/adritian-free-hugo-theme/blame/main/.github/workflows/test-module-init.yml#L35 ) Maybe a npm package would be a good solution, as it can even be distributed in the theme package.hugo.json... Thanks for the input and suggestions - PRs are welcome! They will make the theme better 😃 — Reply to this email directly, view it on GitHub <#191 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALQ3FB3UEMSUELOBD36HMD2NYP4NAVCNFSM6AAAAABWKHGGXGVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMBTGIYTQMQ> . You are receiving this because you were mentioned.Message ID: <zetxek/adritian-free-hugo-theme/repo-discussions/191/comments/12032182@ github.com>

[zetxek]

For the starter repo - would it be something like https://github.com/zetxek/adritian-demo?

And maybe just configuring it so it's a template repo (https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository).

I think that it would work quite well for a quick start (without existing content)...

[mnordhaus]

That is what I am thinking. A minimal template repo AND a demo repo like adritian-demo that gets bundled with the "All-Bats-incl" Zip file. For those who like to work fully offline. Am So., 2. Feb. 2025 um 15:52 Uhr schrieb Adrián Moreno Peña < ***@***.***>:

…

For the starter repo - would it be something like https://github.com/zetxek/adritian-demo? And maybe just configuring it so it's a template repo ( https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository ). I think that it would work quite well for a quick start (without existing content)... — Reply to this email directly, view it on GitHub <#191 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALQ3FDHIOJNKEDOUHUXQOT2NYWKFAVCNFSM6AAAAABWKHGGXGVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMBTGI2DMOI> . You are receiving this because you were mentioned.Message ID: <zetxek/adritian-free-hugo-theme/repo-discussions/191/comments/12032469@ github.com>

[mnordhaus]

For creating content there is also the archetype mechanism that could be utilized a bit more. So just as an idea. Am So., 2. Feb. 2025 um 15:54 Uhr schrieb Markus Nordhaus < ***@***.***>:

…

That is what I am thinking. A minimal template repo AND a demo repo like adritian-demo that gets bundled with the "All-Bats-incl" Zip file. For those who like to work fully offline. Am So., 2. Feb. 2025 um 15:52 Uhr schrieb Adrián Moreno Peña < ***@***.***>: > For the starter repo - would it be something like > https://github.com/zetxek/adritian-demo? > > And maybe just configuring it so it's a template repo ( > https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository > ). > > I think that it would work quite well for a quick start (without existing > content)... > > — > Reply to this email directly, view it on GitHub > <#191 (reply in thread)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AALQ3FDHIOJNKEDOUHUXQOT2NYWKFAVCNFSM6AAAAABWKHGGXGVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMBTGI2DMOI> > . > You are receiving this because you were mentioned.Message ID: > <zetxek/adritian-free-hugo-theme/repo-discussions/191/comments/12032469@ > github.com> >

[zetxek]

the archetypes are used (https://github.com/zetxek/adritian-free-hugo-theme/tree/main/archetypes), how would you use them more? Moving some more content to archetypes (from the config file)?

[mnordhaus]

You can also create Page Bundles as Archetypes for instance. That might be interesting for blog post, where you would add a default image for instance ...

[zetxek]

On template inheritance and baseof - it was sweet and simple! 4ecec55 goes in that direction :)

(this is unrelated, for #190, but it serves to have less template duplication already)