Metadata-Version: 2.4
Name: jupyterlab_macaulay2
Version: 0.3.0
Summary: CodeMirror-based syntax highlighting for Macaulay2 in Jupyter code cells
Project-URL: Homepage, https://github.com/d-torrance/jupyterlab-macaulay2
Project-URL: Bug Tracker, https://github.com/d-torrance/jupyterlab-macaulay2/issues
Project-URL: Repository, https://github.com/d-torrance/jupyterlab-macaulay2.git
Author-email: Doug Torrance <dtorrance9@gatech.edu>
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_macaulay2

[![PyPI version](https://badge.fury.io/py/jupyterlab-macaulay2.svg)](https://pypi.org/project/jupyterlab-macaulay2/)
[![npm version](https://badge.fury.io/js/jupyterlab-macaulay2.svg)](https://www.npmjs.com/package/jupyterlab-macaulay2)
[![Github Actions Status](https://github.com/d-torrance/jupyterlab-macaulay2/workflows/build/badge.svg)](https://github.com/d-torrance/jupyterlab-macaulay2/actions/workflows/build.yml)

CodeMirror-based syntax highlighting for Macaulay2 in Jupyter code cells

The extension registers Macaulay2 with JupyterLab's CodeMirror language
registry, so code cells running the
[Macaulay2 kernel](https://github.com/Macaulay2/Macaulay2-Jupyter-Kernel/) and
files ending in `.m2` are highlighted as you type.

It also highlights Macaulay2 that JupyterLab itself renders plain: `macaulay2`
and `m2` code fences in markdown cells, whatever their case, and the
documentation the kernel emits as raw HTML, which rendermime's markdown
highlighter never sees. Both use the same language and the same theme-aware
colors as the editor.

Alongside that, it fixes a few things about how the kernel's output is laid
out: examples and nets are left-aligned, and documentation `Usage:` lines keep
the label and the code on one line.

## Requirements

- JupyterLab >= 4.3.5

## Install

To install the extension, execute:

```bash
pip install jupyterlab_macaulay2
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterlab_macaulay2
```

## Contributing

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