Skip to main content

JupyterLab GitHub Markdown Alerts Extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4

A JupyterLab 4 extension that renders GitHub-style alert blocks in Markdown cells, providing visual emphasis for notes, tips, warnings, and other important information.

This extension brings GitHub's alert syntax to JupyterLab, allowing you to create styled callout blocks using simple markdown notation. Alerts automatically adapt to light and dark themes, matching GitHub's visual design.

Alert Examples Screenshot

Key Features:

  • Five alert types - NOTE, TIP, IMPORTANT, WARNING, CAUTION
  • Automatic theme adaptation - colors adjust for light and dark modes
  • GitHub-compatible syntax - works with standard GitHub markdown alert notation
  • Icon integration - each alert type displays with its corresponding icon
  • Zero configuration - works immediately after installation

Requirements

  • JupyterLab >= 4.6
  • Python >= 3.10

Usage

Create alert blocks in markdown cells using GitHub's alert syntax. Start with a blockquote containing the alert type, followed by content lines:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Each alert type renders with distinct colors and icons matching GitHub's design. Multi-line content is supported by continuing the blockquote format.

Alert Examples:

Settings

The extension provides optional settings accessible through JupyterLab's Settings Editor:

  • Show Alert Backgrounds - Subtle colored backgrounds for alerts (on by default; turn off to match GitHub exactly)

To access settings: Settings → Settings Editor → GitHub Markdown Alerts

Install

pip install jupyterlab_github_markdown_alerts_extension

Uninstall

pip uninstall jupyterlab_github_markdown_alerts_extension

Contributing

If you would like to contribute to this extension, please refer to the Contributing Guide.

Metadata

Release files for jupyterlab-github-markdown-alerts-extension 1.0.32

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyterlab-github-markdown-alerts-extension 1.0.32
File Size Uploaded Provenance Actions
jupyterlab_github_markdown_alerts_extension-1.0.32.tar.gz 464.6 kB Without provenance Details for jupyterlab_github_markdown_alerts_extension-1.0.32.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-github-markdown-alerts-extension 1.0.32
File Interpreter ABI Platform Actions
jupyterlab_github_markdown_alerts_extension-1.0.32-py3-none-any.whl Python 3 none any Details for jupyterlab_github_markdown_alerts_extension-1.0.32-py3-none-any.whl

Total release size: 503.9 kB

Release files / jupyterlab_github_markdown_alerts_extension-1.0.32.tar.gz

Download URL jupyterlab_github_markdown_alerts_extension-1.0.32.tar.gz
Size 464.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3242141016643971c0ca2ded9beefe88e8ae33aacbcb5d361d492232464dc106
BLAKE2b-256 checksum
How to use checksums
c9693ab11ea32ed622da62f8e1c2638b13167cba9e8864c8becb2a9ee013e542
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / jupyterlab_github_markdown_alerts_extension-1.0.32-py3-none-any.whl

Download URL jupyterlab_github_markdown_alerts_extension-1.0.32-py3-none-any.whl
Size 39.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2cb465fc6b40032e9ab6087152bb8893463491c8ec4c3a59f4ccd2680c0b24e5
BLAKE2b-256 checksum
How to use checksums
362cde52a4586ede32a57166fd5dea5e27fac8b8f46aae25833685e249bea5bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for jupyterlab-github-markdown-alerts-extension 1.0.32

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page