Skip to main content

GFM admonition syntax for Python Markdown

Project description

markdown-gfm-admonition

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.

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

Project details


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

Uploaded Source

Built Distribution

markdown_gfm_admonition-0.1.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file markdown-gfm-admonition-0.1.0.tar.gz.

File metadata

File hashes

Hashes for markdown-gfm-admonition-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8cae54b9a43fe1c0413a9f87999404ec19c6c5072906895940c0f03106d83758
MD5 dd553d51b734ee5509bc72aa5827c392
BLAKE2b-256 89e9e9146e78253baf4bc406b71bd31c4b4eb9f4a36c2d707416111f4fb0b03a

See more details on using hashes here.

File details

Details for the file markdown_gfm_admonition-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_gfm_admonition-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af7680511a61ff74d342f1c1a8450e7355d15368f42548dd8b671bac1de3bdb0
MD5 014c3fb8b8f01c8dfd2dae1b4ed76d50
BLAKE2b-256 7e000e7bc856c20a33219643ec6f88a338e39d99ec45153daa3a987db32d2bdf

See more details on using hashes here.

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