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>
Usage
To use this extension, you need to install it first:
uv add markdown-gfm-admonition
# or
pip install markdown-gfm-admonition
Then, you can use it in your Python code like this:
from markdown import Markdown
from markdown_gfm_admonition import GfmAdmonitionExtension
md = Markdown(extensions=[GfmAdmonitionExtension()])
html = md.convert("""
> [!NOTE]
> Highlights information that users should take into account,
> even when skimming.
""")
Metadata
Release files for markdown-gfm-admonition 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| markdown_gfm_admonition-0.3.0.tar.gz | 5.8 kB | With provenance | Details for markdown_gfm_admonition-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| markdown_gfm_admonition-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for markdown_gfm_admonition-0.3.0-py3-none-any.whl |
Total release size: 12.2 kB
Release files / markdown_gfm_admonition-0.3.0.tar.gz
| Download URL | markdown_gfm_admonition-0.3.0.tar.gz |
|---|---|
| Size | 5.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
20a37febc79222badb6dfbfcbf0a74b94c0a6259b0f27e9f783601fea59094b6
|
|
BLAKE2b-256 checksum How to use checksums |
595b1e7114e8fac6aadf2a25dab2e24a1eba54acd504d6a5747928a3eb09d7fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 28, 2025.
Transparency logRelease files / markdown_gfm_admonition-0.3.0-py3-none-any.whl
| Download URL | markdown_gfm_admonition-0.3.0-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8e49bfea892f4c220b7f7b9479462360b69c68ae7cae7739e288b5382d0ae9b5
|
|
BLAKE2b-256 checksum How to use checksums |
fc86ce4288122111c11bb2483a962357baa9793817d48ac1e99ce5ff47384efe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 28, 2025.
Transparency logSecurity for markdown-gfm-admonition 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for markdown_gfm_admonition-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 28, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.