feat(#2350) Allow relative paths in markdown in docs. #2375
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.
Description
The patch addresses #2350 : and allows the use of relative paths for links and images in the docs section of collections and requests.
Given this doc string:
The current version cannot display the relative path, but can display the image with a full path.
The rendered html is:
With this patch, the rendered HTML is now correct and the client displays the image:
note! this is hard to replicate on the dev environment because (at least on my machine) neither relative or full path images can be displayed. I suspect this is an issue with permission and electron. Building for your environment through the correct npm action should allow you to validate the behavior.
Contribution Checklist:
Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.
Publishing to New Package Managers
Please see here for more information.