Skip to main content

GFM admonition syntax for Python Markdown

Project description


PyPI GitHub Actions status

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.

> Crucial information necessary for users to succeed.

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

> 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>

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-gfm-admonition-0.1.0.tar.gz (6.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page