chore: refine shared build targets and npm scripts across docs and academy repos #174
+1,284
−196
There are no files selected for viewing
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: layer5io/academy-example
Length of output: 162
🏁 Script executed:
Repository: layer5io/academy-example
Length of output: 15035
🌐 Web query:
Hugo render hooks page resources bundle context Resources.GetMatch parent resources💡 Result:
To access page resources within a Hugo render hook, you use the.Page object available in the render hook context to call resource methods like.Resources.GetMatch [1][2][3]. Key considerations for accessing these resources include: 1. Accessing Page Resources: Inside a render hook, the.Page object represents the page currently being rendered [3]. You can access its bundled resources by calling.Page.Resources.GetMatch.Destination (or.Get) [4][5][2]. Note that.Destination contains the link or image path from the Markdown file [5][2]. 2. Bundle Context: Page resources are only available if the content file is part of a page bundle (a directory with an index.md or _index.md file) [1][6]. If the page is not a bundle, or if the resource is not correctly associated with that bundle, the lookup will fail [7][3]. 3. Branch Bundles: If you are working with a branch bundle (e.g., a sub-page within a section), you may need to access the parent page's resources if the current page itself is not a bundle or does not contain the target resource [7]. In such cases, you can use.Page.Parent.Resources.GetMatch [7]. 4. Fallback Strategy: Because render hooks are applied globally to images or links, it is a common best practice to implement a fallback mechanism [5][3]. You can attempt to find the resource in the page bundle first, and if not found, fall back to global assets using the resources.Get function [5]. Example implementation pattern: {{ $r:=.Page.Resources.GetMatch.Destination }} {{ if not $r }} {{ $r = resources.Get.Destination }} {{ end }} {{ with $r }} <img src="{{.RelPermalink }}"...> {{ end }} This ensures your render hook gracefully handles both page-local resources and global assets [5].
Citations:
🌐 Web query:
Hugo image render hook markdown image syntax Resources.GetMatch relative to markdown page💡 Result:
In Hugo, image render hooks use the
{{ else }} 
{{ end }} 3. Pathing: Ensure your Markdown image syntax uses a path relative to the page bundle (e.g.,
.Pagecontext to resolve resources. To resolve an image relative to the current Markdown page (typically a leaf bundle), you use the.Page.Resources.GetMatchmethod within yourrender-image.htmlhook [1][2]. Key considerations for implementation: 1. Context: Use.Pageto access the page-level resources [1]. Inside a render hook, the.Destinationvariable contains the image URL provided in your Markdown [1][3]. 2. Resolution Strategy: Because Markdown image links are treated as destinations, they are not automatically resolved to page resources by default in the same wayreforrelrefwork unless you use a render hook [1][4]. A robust implementation typically checks for the resource in the current page bundle first, and often falls back to the globalassetsdirectory [3]: {{ $destination:=.Destination }} {{ $image:=.Page.Resources.GetMatch $destination }} {{ if not $image }} {{ $image = resources.Get $destination }} {{ end }} {{ with $image }}or, not an absolute path starting with/) [5][6]. If you use a leading slash, Hugo may attempt to resolve the image from the root of the site, causingGetMatchto fail because it is scoped to the page bundle [6]. 4. Advanced Note: If you are using components or nested structures where content might be included (e.g., viaRenderShortcodes), you may consider using.PageInnerinstead of.Pageto ensure the context remains consistent with the file currently being rendered [1]. Always wrap your resource access inwithorifstatements to handle cases where the file cannot be found, preventing your build from failing with a nil pointer error [3][6].Citations:
Use a leaf-bundle image path for the Page Bundling example.
The example puts
hugo-logo.pngin<your-module>/but then haslesson-1.mdreference it. Hugo resolves Markdown images relative to the Markdown page unless the image render hook specifically searches parent resources, so place the image in the referenced page’s bundle.Proposed documentation fix
📝 Committable suggestion
🤖 Prompt for AI Agents