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.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file markdown_gfm_admonition-0.1.1.tar.gz.

File metadata

File hashes

Hashes for markdown_gfm_admonition-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a0cb00d183b2be4a4bfc355a74500ddb9818c7ce8d9ac99a63ba7f689866c13d
MD5 d1d9b113db8f0f58e58cfa4d81b99db6
BLAKE2b-256 638005c5b58356c85c336e88eaaae49bd058917531504914dd1c95b5a52a851b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_gfm_admonition-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6626287a34adf0cdc44f953086fcb9aaaf0cb698f01f3a36b46758c30f7d701
MD5 f715f174aa23b8886f1daebe2c76ae9e
BLAKE2b-256 62fee7ccdd9e542afebf61e95f0a0ce0557c494e798d8ca39903a7f9bd83bdca

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