fix: resolve relative markdown links to repository blob URLs #698
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
Previously, relative .md links in READMEs would resolve to jsdelivr CDN (which returns raw markdown text) or raw GitHub URLs. This caused 404s for files not in the npm tarball and poor UX for files that exist. Changes: - Add getBlobBaseUrl to all git provider configs - Add blobBaseUrl to RepositoryInfo interface - Update resolveUrl to use blob URLs for .md files (so they render) - Leave .md links unchanged if no repo info (matches npm behavior) This allows users to navigate to other documentation files and see them rendered properly on the source repository. Fixes npmx-dev#617
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Contributor
Author
|
Closing to recreate with a clean branch from main (was incorrectly based on #650). |
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
Resolves relative markdown (.md) links in READMEs to the source repository's blob URLs instead of raw URLs or jsdelivr CDN.
Problem
As reported in #617, relative links to other markdown files in READMEs were resolving incorrectly:
Example from issue:
Solution
Added \getBlobBaseUrl\ to all git providers - Returns the base URL for viewing rendered files (e.g., /blob/\ for GitHub, /src/\ for Gitea/Codeberg, /-/blob/\ for GitLab)
Updated \RepositoryInfo\ interface - Now includes \blobBaseUrl\ alongside \rawBaseUrl\
Modified \resolveUrl\ logic for \.md\ files:
Supported Providers
Fixes #617
Found this helpful? ☕ Buy me a coffee