search

postmanlabs / postman-app-support

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
https://www.postman.com
5.83k stars 838 forks source link

Preserve whitespace when rendering diffs of markdown in Pull Request #10050

Open bsredbeard opened 3 years ago

bsredbeard commented 3 years ago

Is your feature request related to a problem? Please describe. When reviewing changes in a collection's markdown documentation via the Pull Request interface, all text is rendered as a single line. This makes it very difficult for reviewers to understand the actual changes being proposed in markdown fields with lists, headings, or other markdown formatting syntax which relies on line-breaks.

Describe the solution you'd like Render diffs for markdown fields with whitespace preserved so that reviewers can more easily understand the highlighted differences in markdown fields.

Describe alternatives you've considered

  1. Navigate to original collection - copy markdown to external diff tool; navigate to fork - copy markdown to external diff tool; add comments back to Postman Pull Request
  2. View original collection and collection fork in "Documentation" views, manually comparing while switching UI tabs without the benefit of diff highlighting.
  3. Opening one collection's documentation in a web view and one in the app to view them side-by-side without the benefit of diff highlighting.

Additional context Postman version: 8.6.2 Platform: Mac App + Web

Screenshot:

Postman Markdown Diff
Oleksandrnec commented 1 year ago

Hf