wonyoung-jang / hugo-PolyRhythmic

A (mostly) CSS implementation of Material Design 3, as a Hugo theme. Read more at https://wonyoungjang.org/hugo-polyrhythmic/
https://polyrhythmic.xyz
MIT License
19 stars 1 forks source link

Is there a Getting Started guide? #3

Open TechnicJelle opened 6 days ago

TechnicJelle commented 6 days ago

Hi! My friend and I tried using this theme for a website, because it looks wonderful, and has a lot of features! :D

However, we're both kind of new to Hugo, and we were wondering if there was some kind of introductory guide on how to use this theme? We saw the demo website, and all of its Material 3 features and showcases. But it didn't really explain the basics to us very well, and the config options the theme has.

We tried using the code from the demo repo as example, but there are just so many files in there. All of them Do Things, but we can't really figure out what does what. And how to achieve the things we want to achieve.

Like, for example, where does that Share widget come from, with the social media links? It's not defined anywhere in our content/code/markdown/config, so it must be coming from the theme. But how do we specify when and where it shows up? And how do we override the links?

And when we finally managed to add an image to a post, it was cropped to a square, instead of being its own proper size.

We did manage to configure a custom site icon, though!

wonyoung-jang commented 3 days ago

Hello!

This is on my "things to do" list. The theme is more just my website's theme and yeah I apologize for how many files there are with no user guide haha. I am working on a user guide, but in the meantime to answer your question, the share widget is currently in the page-links partial here, and is called by the baseof.html template, which is the skeleton for every page, so that's where I'd start customizing that.

I would love to help you achieve what you want to achieve, so please don't hesitate to ask more questions!