feat: convert relative image urls to absolute #626
Merged
Conversation
This file contains 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
|
Nice work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 introduces functionality to automatically convert relative image URLs to absolute ones in plugin documentation and fixes existing issues with plugins that have already been merged with relative image URLs or got updated.
Background
Currently, we require plugin authors to manually convert relative URLs to absolute ones. This process is cumbersome and error-prone. Moreover, even if authors comply, future updates to the README may inadvertently reintroduce relative URLs.
Implementation Details
Reworking the Markdown Class:
The Markdown class has been modified to accept the plugin documentation URL. This allows the system to resolve and convert image URLs based on the correct branch, ensuring accuracy and consistency.
Foundation for Future Enhancements:
This update lays the groundwork for additional replacements, such as converting video links into corresponding HTML tags. This functionality will be implemented in a future PR if this one is accepted.
By automating this process, we improve reliability and reduce the burden on plugin authors.