iamcco / iamcco/markdown-preview.nvim

Feature: Support Github Flavor notes

Open
#632 3 comments 16 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
8k
Forks
411
PR merge metrics
No merged PRs in 30d

Description

In Github flavored markdown, a note or "alert" can be created with the following syntax:

```
> [!Note]
> *insert note here*
```

and the note will appear with an icon like so:

> [!Note]
> this is a note

Here is an screenshot:

![image](https://github.com/iamcco/markdown-preview.nvim/assets/122305393/fc4fae89-1979-4d30-982f-9b6e51bf8ad6)

`[!Important]` and `[!Warning]` have a similar layout.

This is not supported in markdown preview, and I would love to see it implemented. I understand, however, if the goal of the plugin is to support vanilla markdown, not the GitHub flavor.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.