Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(#2350) Allow relative paths in markdown in docs. #2375

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shawnsarwar
Copy link

@shawnsarwar shawnsarwar commented May 28, 2024

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:
Screenshot 2024-05-28 at 16 50 32

The current version cannot display the relative path, but can display the image with a full path.
The rendered html is:
Screenshot 2024-05-28 at 16 51 03

With this patch, the rendered HTML is now correct and the client displays the image:

Screenshot 2024-05-28 at 16 51 33

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:

  • The pull request only addresses one issue or adds one feature.
  • The pull request does not introduce any breaking changes
  • I have added screenshots or gifs to help explain the change if applicable.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant