dahlia/markdown-gfm-admonition

An extension of Python Markdown that enables the admonition syntax of GFM

markdown-gfm-admonition

This package is an extension of Python Markdown that enables the admonition syntax of GitHub Flavored Markdown.

There are five types of admonitions:

> [!NOTE]  
> Highlights information that users should take into account,
> even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

It generates the same HTML as Python Markdown's built-in admonition extension:

<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Highlights information that users should take into account,
even when skimming.</p>
</div>

markdown-gfm-admonition's Issues

Request: Support escaped brackets

Thanks for a great extension! We're currently testing it out with our mkdocs setup using the materials theme, which renders it nicely.

Our challenge is that we're using mdformat as a pre-commit hook, which escapes the brackets (> [!NOTE] -> > \[!NOTE\]).

It works fine in Github render (so devs don't notice). Would it be possible to add this to the pattern as well?

Example with escaped brackets:

> \[!NOTE\]
> this is a note

Note

this is a note