Skip to main content

A MathJax Typesetting provider for JupyterLab 4 and above

Project description

jupyterlab_mathjax2

Github Actions Status A MathJax Typesetting provider for JupyterLab

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_mathjax2

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_mathjax2

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_mathjax2 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 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 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 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

Development uninstall

pip uninstall jupyterlab_mathjax2

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named @jupyterlab/mathjax2-extension within that folder.

Packaging the extension

See RELEASE

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_mathjax2-4.0.0.tar.gz (37.3 kB view details)

Uploaded Source

Built Distribution

jupyterlab_mathjax2-4.0.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_mathjax2-4.0.0.tar.gz.

File metadata

  • Download URL: jupyterlab_mathjax2-4.0.0.tar.gz
  • Upload date:
  • Size: 37.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for jupyterlab_mathjax2-4.0.0.tar.gz
Algorithm Hash digest
SHA256 1748fc09e18ef6f878670e400932dc3a08db012d97f4680c238a3a38f7af2461
MD5 e9673352ac10685dc3c3a6acb0751cc4
BLAKE2b-256 96619a5c0fd7acc64a309d343c91b2665d404897f5877ea1868e3d9bcc1cdd8f

See more details on using hashes here.

File details

Details for the file jupyterlab_mathjax2-4.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_mathjax2-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c65c401ee5638e7cbf1223ba95aceed8b26a2a3e48fd1d585a10dd95b9327a8f
MD5 4172e36b068af6a3f36c26a3f1946dc9
BLAKE2b-256 5246bb4cb93fb0642ed7800ddb9461daaee298d311ef0cf310acc2f71772d21b

See more details on using hashes here.

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