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

Markdown Preview is not correctly rendering #58

Open
Mosiwi opened this issue Oct 19, 2023 · 6 comments
Open

Markdown Preview is not correctly rendering #58

Mosiwi opened this issue Oct 19, 2023 · 6 comments
Labels
bug Something isn't working

Comments

@Mosiwi
Copy link

Mosiwi commented Oct 19, 2023

The Markdown Preview is not correctly rendering the MyST enhancements.
The following enhanced markdown is ignored and only the content is rendered as plain text.

``` {tip} this is a MyST tip that fails! ```

and

``` {note} this is a MyST tip that fails! ```

The MyST-Markdown extension is enabled since highlighting, intellisense, etc works on the enhanced MyST. However it seems that the enhanced Preview part is either not working or not activated. None of the enhanced MyST markup is previewing as expected.

Desktop:
Windows 11,
VSCodeUserSetup-x64-1.83.1
MyST-Markdown 2.0.0

@Mosiwi Mosiwi added the bug Something isn't working label Oct 19, 2023
@welcome
Copy link

welcome bot commented Oct 19, 2023

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@Mosiwi
Copy link
Author

Mosiwi commented Oct 19, 2023

Screenshot of Edit and Preview panes in VSCode:
image

@FernandoBasso
Copy link

It is working fine on my side on Arch Linux with VS Code 1.88.0 and all extensions up to date:

myst vscode preview working fine

@iso2013
Copy link

iso2013 commented May 11, 2024

It also works on my machine; maybe you need to rename the file to end in .myst.md for it to enable?

@adam-grant-hendry
Copy link

The op states the problem is in Windows 11, not Arch Linux. I have the same issue on Windows 10. Your test suite in your ci.yml only tests on Ubuntu.

@adam-grant-hendry
Copy link

adam-grant-hendry commented Nov 24, 2024

Removing alternative extensions one-by-one, the culprit for me seemed to be by having both of the following extensions enabled:

Disabling Markdown Preview Enhanced seems to make the problem go away.

Caveats:

  1. You may no longer have a button to render the markdown. Instead, you might have to resort to using ctrl+shift+v. (Reloading the developer window seemed to fix that for me).
  2. If you use the code fences syntax (:::) for your admonitions rather than backticks (```), you need to enable code_fences in your `settings.json`
"myst.preview.extensions": [
    "dollarmath",
    "colon_fence"
  ]
  1. Also be sure you don't have any other extensions enabled that might make the output look "odd" (e.g. Dark GitHub Markdown Preview)

image

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

4 participants