Add --hugo-relative-image-links flag for portable image paths#456
Draft
klocke-io wants to merge 1 commit into
Draft
Add --hugo-relative-image-links flag for portable image paths#456klocke-io wants to merge 1 commit into
klocke-io wants to merge 1 commit into
Conversation
When enabled, embedded resource links (images) are resolved as relative paths from the source node to the destination instead of being prefixed with hugo-base-url. This produces portable markdown paths like ./image.png that work with VitePress and other static site generators that do not support Hugo-style root-relative URL rewriting. The isEmbeddable boolean, already tracked in the link resolution chain, is now threaded through to ResolveResourceLink so the resolver can distinguish images from regular links and apply the relative path computation only to embeddable resources.
gardener-prow
Bot
added
the
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
gardener-prow
Bot
added
do-not-merge/needs-kind
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
--hugo-relative-image-linksCLI flag (defaultfalse)hugo-base-urlisEmbeddableboolean throughResolveResourceLinkso the resolver can distinguish images from regular linksMotivation
Static site generators like VitePress do not support Hugo-style root-relative URL rewriting via a base URL prefix. This flag produces portable markdown image paths (e.g.
./image.png) that work across different SSGs without post-processing.Changes
cmd/hugo/option.go: AddedRelativeImageLinksfield to Hugo config structcmd/app/flags.go: Added--hugo-relative-image-linksCLI flagpkg/nodeplugins/markdown/linkresolver/link_resolving.go: ExtendedInterfaceand implementation withisEmbeddableparameter; added relative path computation when flag is enabledpkg/nodeplugins/markdown/document/document_worker.go: PassisEmbeddabletoResolveResourceLinkcalls (falsefor links,truefor embedded)pkg/nodeplugins/markdown/linkresolver/linkresolverfakes/fake_interface.go: Updated generated fake for new signaturepkg/nodeplugins/markdown/linkresolver/link_resolving_test.go: Updated test call sites for new signatureTest plan
go build ./...passes