Relative links in readme fixed#36
Open
hRupanjan wants to merge 5 commits into
Open
Conversation
* Relative Link Fix * Multiple Fixes for Relative Link handling
pastelsky
requested changes
Jan 15, 2024
| throw new Error("Compile error"); | ||
| } | ||
|
|
||
| await updateReadmeRelativeLinks( |
Owner
There was a problem hiding this comment.
We'd also need to do this as a post-load script.
The updateReadmeRelativeLinks would only work for newly generated docs.
Author
There was a problem hiding this comment.
Yes. Currently it only works for newly generated docs.
- moving utility functions to the respective file
- some optimisations for relative path replacement function
hRupanjan
changed the title
|
Thanks for you work! I'd love to see this feature, but as I also pointed out in the related issue, I think relative links should link to files next to the originating one, so inside the same published NPM package, not within it's repo. -- #9 (comment) |
Author
|
You are welcome 😊. I did mention the issues in the main issue thread. |
sn2912
reviewed
Mar 24, 2025
| import { CachedPackageInfo, InstallPackageOptions, VersionData } from "./types"; | ||
| import { config } from "dotenv"; | ||
|
|
||
| config({ |
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
4 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.
This PR solves the bug mentioned in the issue #9
It handles all type of relative links in a readme file viz.
I have tested for possible test cases. But, consider testing it more.
Packages that I have tested on: @primer/react, lit