https://github.com/jupyterlab/jupyterlab_pygments
Pygments theme making use of JupyterLab CSS variables
https://github.com/jupyterlab/jupyterlab_pygments
Last synced: 15 days ago
JSON representation
Pygments theme making use of JupyterLab CSS variables
- Host: GitHub
- URL: https://github.com/jupyterlab/jupyterlab_pygments
- Owner: jupyterlab
- License: bsd-3-clause
- Created: 2019-05-20T16:13:45.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T22:34:09.000Z (8 months ago)
- Last Synced: 2025-03-31T13:21:31.592Z (22 days ago)
- Language: Python
- Size: 1.62 MB
- Stars: 45
- Watchers: 12
- Forks: 36
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# JupyterLab Pygments Theme
This package contains a syntax coloring theme for [pygments](http://pygments.org/) making use of
the JupyterLab CSS variables.
The goal is to enable the use of JupyterLab's themes with pygments-generated HTML.
## Screencast
In the following screencast, we demonstrate how Pygments-highlighted code can make use of the JupyterLab theme.
## Installation
`jupyterlab_pygments` can be installed with the conda package manager
```
conda install -c conda-forge jupyterlab_pygments
```
or from pypi
```
pip install jupyterlab_pygments
```
## Dependencies
- `jupyterlab_pygments` requires [pygments](http://pygments.org) version `2.4.1`.
- The CSS variables used by the theme correspond to the CodeMirror syntex coloring
theme defined in the NPM package [@jupyterlab/codemirror](https://www.npmjs.com/package/@jupyterlab/codemirror). Supported versions for `@jupyterlab/codemirror`'s CSS include `0.19.1`, `^1.0`, and, `^2.0`.
## Limitations
Pygments-generated HTML and CSS classes are not granular enough to reproduce
all of the details of codemirror (the JavaScript text editor used by JupyterLab).
This includes the ability to differentiate properties from general names.
## License
`jupyterlab_pygments` uses a shared copyright model that enables all contributors to maintain the
copyright on their contributions. All code is licensed under the terms of the revised [BSD license](LICENSE).