Improved image handling

rootwork commented 2 years ago

Changes / fixes

Summary of changes

Images correctly use .RelPermalink rather than a direct link, to accommodate changed permalinks when using bundles.
Featured image captions and alt text are correctly displayed (this was a regression; unsure when).
SVGs will no longer cause a site build failure, they simply won't be passed through Hugo Pipes/imageConfig (as Hugo doesn't support that). I also added a new image_svg class because I needed something to hook off of anyway and I figured we might as well provide that to users.
Documentation updated, including clarifying some things with how image captions work.

Screenshots (if applicable)

N/A -- this is dealing with cases not contained in any of the default exampleSite pages (so none of them are changed) and the only visual difference is that in certain use cases things show up where they didn't before.

Checklist

Ensure you have checked off the following before submitting your PR.

[x] tested locally with the latest release of Hugo. This requirement is a standard
[x] added new dependencies (n/a)
[x] updated the [docs]() ⚠️

rootwork commented 2 years ago

I'd really like some testing of this before merge. For those other than @chipzoller @onweru, you can test by:

a) If you used git to download the theme, within your Hugo Clarity theme directory run git pull and then git checkout image-handling-improvements

b) If you didn't use git to download the theme, download this zipfile and replace the contents of your hugo-clarity theme directory with its contents. When you're done testing, you can swap back to the contents of the default zipfile.

rootwork commented 2 years ago

Incidentally I opened gohugoio/hugo#9875 while working on the SVG portion of this PR.

rootwork commented 2 years ago

Playing with this further, I think I may have broken the modern image support in the process. But would still appreciate testing.

jbowdre commented 2 years ago

Thanks @rootwork, this does fix the issue(s) I was encountering in #291!

I can confirm that it does seem to have broken the modern image support along the way though. I'll keep poking to see if I see anything else acting weird.

rootwork commented 2 years ago

OK, I believe the image replacement is working again -- and I think I didn't break anything in the process. @jbowdre if you get a chance can you confirm that at least the newest changes are still working for your issue?

jbowdre commented 2 years ago

Yep, still good here - plus the modern image stuff is working again too. 👍

chipzoller / hugo-clarity