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

Docs Tab: documentation with markdown support #1594

Open
ericm301 opened this issue Aug 29, 2024 · 2 comments
Open

Docs Tab: documentation with markdown support #1594

ericm301 opened this issue Aug 29, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@ericm301
Copy link

ericm301 commented Aug 29, 2024

Describe the bug
Markdown is not rendered properly.

No documentation is provided for this tab.

To Reproduce

  • Create simple .md file in VSCode and Preview it.
  • Copy to Docs tab on a request/response window (Click Edit button).
  • Click Done.
  • Compare preview with result in Docs Tab.

Expected behavior
I would expect that the markdown would display identically in both views.

Platform:

  • OS: Win10
  • vscode version: 1.92.2
  • node version: 20.10.0
  • extension version: 2.24.13

Are you using the free version/paid version/trial:
Free

Here is the Docs tab in editor mode, showing code with a numbered list:
image

Here is the Docs tab in reader mode with the list shown as bullets:
image

@ericm301 ericm301 added the bug Something isn't working label Aug 29, 2024
@rangav
Copy link
Collaborator

rangav commented Aug 30, 2024

Thanks @ericm301 for the feedback, Will review it.

@rangav
Copy link
Collaborator

rangav commented Dec 8, 2024

Documentation formatting is based on GitHub markdown formatting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants