bypikod/vscode-markdown-alert

VS Code Admonition Box Syntax Preview Support for Markdow

VS Code Markdown Alert

This is a VS Code extension that allows you to preview GitHub's alert syntax for markdown files. This feature first introduced in this discussion post. And this extension is the first implementation of this feature in VS Code.

You can install the extension from VS Code Marketplace.

Syntax below,

> [!NOTE]
> Hello, world!

should look like this,

Note

Hello, world!

And this it looks like in VS Code via this extension,

How does it work?

For those who are interested in how this extension works, here is a brief explanation.

VS Code uses a javascript library named markdown-it to render markdown files. This library allows you to add custom rules to the markdown parser. This extension adds a custom rule to the parser to render GitHub's alert syntax using markdown-it-github-alert plugin of Markdown-it which is also written by me.

For further information, you can check out the source code of this extension and the plugin.

Contribute

Contribution

We welcome and appreciate contributions from the community! To contribute to this project, follow these steps:

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Make your changes and ensure they pass any existing tests.
• Open a pull request with a clear title and description.
• Participate in the code review process.

Thank you for helping make this project better!

Copyright

This project is licensed under the terms of the MIT License.

You are free to use this project in compliance with the MIT License. If you decide to use, modify, or redistribute this software, you must include a copy of the original license and copyright notice in all copies or substantial portions of the software.

For more information about the MIT License, visit: MIT License.

Enjoy!

vscode-markdown-alert's Issues

Failed to display alerts correctly

The extension fails to display the Alert markdown extension correctly. For instance, given

> [!IMPORTANT]
> - **Foo**: _bar_ baz

It should look like

Important

• Foo: bar baz

But the extension fails to display it correctly.

Request textDocument/documentLink failed

Every time that I open a quote block the following error is logged in the Markdown Language Server:

[Error - 3:24:58 PM] Request textDocument/documentLink failed.
  Message: Request markdown/parse failed with message: Cannot read properties of undefined (reading 'type')
  Code: -32603 

This only happen if the yahyabatulu.vscode-markdown-alert extension is enabled.

Update to 2.0.4 breaks the collaboration with bierner.github-markdown-preview

mjbvz/vscode-github-markdown-preview-style#134 (comment)

Github admonition can't be nested within other elements

With Update - 14 November 2023 Github disable support for admonition in nested elements...

Update - 14 November 2023
[...]
Prevent alerts from being nested within other elements.

Source

It would be nice, if we could also disable it for this extension to have the same behaviour as on Github.

[Bug] GitHub "Alert" Syntax Formatting Problem

Note

I follow the issue from mjbvz/vscode-github-markdown-preview-style#135; therefore, I paste the content here, if no expected, I can close this issue ASAP.

Issue with GitHub "Alert" Syntax in New Markdown Preview

While using this extension, the GitHub "alert" syntax experiences formatting issues during rendering, as demonstrated in the video below. This requires some adjustments. Despite this, the extension is a great solution to address my issue microsoft/vscode#214732 in VSCode.

Screen.Recording.2024-06-10.at.1.47.07.PM.mov

Expected:

The current effect:

related: #4

Thanks a lot!!!