Skip to main content

MathJax 3 math renderer for JupyterLab

Project description

jupyterlab-mathjax3

A JupyterLab extension for rendering math with MathJax 3.

The default LaTeX renderer in JupyterLab uses MathJax 2. This extension substitutes the MathJax 2 renderer with the MathJax 3 renderer.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab-mathjax3

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-mathjax3 directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab-mathjax3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab-mathjax3-4.3.0.tar.gz (531.6 kB view details)

Uploaded Source

Built Distribution

jupyterlab_mathjax3-4.3.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-mathjax3-4.3.0.tar.gz.

File metadata

  • Download URL: jupyterlab-mathjax3-4.3.0.tar.gz
  • Upload date:
  • Size: 531.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for jupyterlab-mathjax3-4.3.0.tar.gz
Algorithm Hash digest
SHA256 daee13969453ecfa22ac8969cd1daa8f887731ace8adb93a574b47aecabdc5dd
MD5 6c19a08ac8cc42d3c6dc818fd1f0a0ee
BLAKE2b-256 e3b618e44ef4ca8d74c7c239941c76acfd4b4127867893778ff4bd2691a6c9df

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_mathjax3-4.3.0-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_mathjax3-4.3.0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for jupyterlab_mathjax3-4.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 07d2a40cea9293bb56210b87620088e6aa5bb45c05aac86d3e917d6c1aded711
MD5 1c717a2464446dbe793d47979c3ba8a8
BLAKE2b-256 213f9ac19d2883f58ba3ce14d34afcb993a6274154935b0bff4d75189b973d67

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page