Metadata-Version: 2.5
Name: jupyterlab_github_markdown_alerts_extension
Version: 1.0.25
Summary: Jupyterlab extension to render alerts tips like they are rendered in github in markdown
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension.git
Author-email: Stellars Henson <konrad.jelen@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: jupyter-builder>=1.2.0; extra == 'dev'
Requires-Dist: jupyterlab>=4; extra == 'dev'
Description-Content-Type: text/markdown

# JupyterLab GitHub Markdown Alerts Extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/jupyterlab_github_markdown_alerts_extension.svg)](https://www.npmjs.com/package/jupyterlab_github_markdown_alerts_extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-github-markdown-alerts-extension.svg)](https://pypi.org/project/jupyterlab-github-markdown-alerts-extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-github-markdown-alerts-extension)](https://pepy.tech/project/jupyterlab-github-markdown-alerts-extension)
[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)

> [!TIP]
> This extension is part of the [stellars_jupyterlab_extensions](https://github.com/stellarshenson/stellars_jupyterlab_extensions) metapackage. Install all Stellars extensions at once: `pip install stellars_jupyterlab_extensions`

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](.resources/screenshot.png)

**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.0.0

## 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**:

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

## Settings

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

- **Show Alert Backgrounds** - Enable subtle colored backgrounds for alerts (disabled by default to match GitHub exactly)

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

## Install

```bash
pip install jupyterlab_github_markdown_alerts_extension
```

## Uninstall

```bash
pip uninstall jupyterlab_github_markdown_alerts_extension
```

## Contributing

If you would like to contribute to this extension, please refer to the [Contributing Guide](CONTRIBUTING.md).
