feat: make image render hook aware of assets directory #657
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for hugo-hextra ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
imfing
approved these changes
Apr 3, 2025
Comment on lines
+28
to
+42
| {{- $attributes := "" -}} | ||
| {{- range $key, $value := .Attributes -}} | ||
| {{- if $value -}} | ||
| {{- $pair := printf "%s=%q" $key ($value | transform.HTMLEscape) -}} | ||
| {{- $attributes = printf "%s %s" $attributes $pair -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{- with .Title -}} | ||
| <figure> | ||
| <img src="{{ $dest | safeURL }}" title="{{ . }}" alt="{{ $alt }}" {{ if $lazyLoading }}loading="lazy"{{ end }} /> | ||
| <img src="{{ $dest | safeURL }}" title="{{ . }}" alt="{{ $alt }}" {{ $attributes | safeHTMLAttr }} {{ if $lazyLoading }}loading="lazy"{{ end }} /> | ||
| <figcaption>{{ . }}</figcaption> | ||
| </figure> | ||
| {{- else -}} | ||
| <img src="{{ $dest | safeURL }}" alt="{{ $alt }}" {{ if $lazyLoading }}loading="lazy"{{ end }} /> | ||
| <img src="{{ $dest | safeURL }}" alt="{{ $alt }}" {{ $attributes | safeHTMLAttr }} {{ if $lazyLoading }}loading="lazy"{{ end }} /> |
Owner
There was a problem hiding this comment.
thanks for also adding the attributes 🙌
Comment on lines
+13
to
+21
| {{- with or (.PageInner.Resources.Get $url.Path) (resources.Get $url.Path) -}} | ||
| {{/* Images under assets directory */}} | ||
| {{- $query := cond $url.RawQuery (printf "?%s" $url.RawQuery) "" -}} | ||
| {{- $fragment := cond $url.Fragment (printf "?%s" $url.Fragment) "" -}} | ||
| {{- $dest = printf "%s%s%s" .RelPermalink $query $fragment -}} | ||
| {{- else -}} | ||
| {{/* Images under static directory */}} | ||
| {{- $dest = (relURL (strings.TrimPrefix "/" $dest)) -}} | ||
| {{- end -}} |
Owner
There was a problem hiding this comment.
I saw this in the hugo builtin rener hook 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The image render hooks resolves image URLs in Markdown. So far the implementation in this theme simply assumes that those images are placed in
/staticor relative to the referencing page, while those in/assetsare ignored. Because Hugo lazily copies files in/assetsonly when they are explicitly referenced (such as shortcodes), images located in/assetsand dependent on pages usingsyntax will not be published, and the corresponding links will actually point to nothing.This PR updates the hook, which now first tries to resolve a image whose link starts with
/to a global resource (i.e./assets), and fallbacks to/staticwhen the image doesn't exist in/assets.In addition, when the markdown attributes feature is enabled, attributes like
{.class #id}should be preserved if exists. This PR also adds this functionality to make markdown attributes work with the image render hook.