GitHub - jupyter-book/jupyterlab-myst at v0 (original) (raw)

jupyterlab-myst

Note: If you are looking for the version of this repository based on mystjs, see the main branch. The work on this version of the extension stopped in Feb 2023. See discussion.

A Myst renderer for JupyterLab.

This is a repository to track to-do items and potentially infrastructure around integrating the MyST language with JupyterLab (or potentially other Jupyter interfaces).

🛑🛑EXPERIMENTAL🛑🛑 - this repository is in the early stages and may evolve rapidly. Please do try it out, and provide feedback if you like, but it is not production ready.

Requirements

• JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab-myst

To enable eval rendering, install the eval extra:

pip install "jupyterlab-myst[eval]"

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-myst

Contributing

Development install

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

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

Clone the repo to your local environment

Change directory to the jupyterlab-myst 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

Development uninstall

pip uninstall jupyterlab-myst

In development mode, you will also need to remove the symlink created by jupyter labextension developcommand. To find its location, you can run jupyter labextension list to figure out where the labextensionsfolder is located. Then you can remove the symlink named jupyterlab-myst within that folder.