Package: jupyterlab-myst
JupyterLab MyST ExtensionRender markdown cells usingMyST Markdown, including support for rich frontmatter, interactive references, admonitions, figure numbering, tabs, proofs, exercises, glossaries, cards, and grids!Note: If you are looking for the version of this repository based on jupyterlab-markup,
see thev0 branch.InfoThis extension is composed of a Python package namedjupyterlab_mystfor the server extension and a NPM package namedjupyterlab-mystfor the frontend extension.RequirementsJupyterLab >= 4.0.0InstallTo install the extension, execute:pipinstalljupyterlab_mystFeaturesjupyterlab-mystis a fully featured markdown renderer for technical documents,get started with MyST Markdown. It supports the MyST{eval}inline role, which facilitates the interweaving of code outputs and prose. For example, we can use inline expressions to explore the properties of a NumPy array.In the code cell:importnumpyasnparray=np.arange(4)In the markdown cell:Let's consider the following array: {eval}`array`.

We can compute the total: {eval}`array.sum()` and the maximum value is {eval}`array.max()`.This will evaluate inline, and show:Let's consider the following array: array([0, 1, 2, 3]).

We can compute the total: 6 and the maximum value is 3.You can also use this withipywidgets, and have inline interactive text:Or withmatplotlibto show inline spark-lines:You can also edit task lists directly in the rendered markdown.UsageMySTis a flavour of Markdown, which combines the fluid experience of writing Markdown with the programmable extensibility of reStructuredText. This extension for JupyterLab makes it easier to develop rich, computational narratives, technical documentation, and open scientific communication.Execution 🚀To facilitate inline expressions,jupyterlab-mystdefines ajupyterlab-myst:executorplugin. This plugin sends expression code fragments to the active kernel when the user "executes" a Markdown cell. To disable this functionality, disable thejupyterlab-myst:executorplugin with:jupyterlabextensiondisablejupyterlab-myst:executorTrust 🔎Jupyter Notebooks implement atrust-based security model. With the addition of inline expressions, Markdown cells are now considered when determining whether a given notebook is "trusted". Any Markdown cell with inline-expression metadata (with display data) is considered "untrusted". Like outputs, expression results are rendered using safe renderers if the cell is not considered trusted.
Executing the notebook will cause each cell to be considered trusted.To facilitate this extension of the trust model, thejupyterlab_mystserver extension replaces theNotebookNotaryfromnbformatwithMySTNotebookNotary. This can be disabled withjupyterserverextensiondisablejupyterlab-mystBy disabling this extension, it will not be possible to render unsafe expression results from inline expressions; theMySTNotebookNotaryadds additional code that makes it possible to mark Markdown cells as trusted.UninstallTo remove the extension, execute:pipuninstalljupyterlab_mystTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab_myst directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyterlab_myst# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith 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, thejlpm buildcommand 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:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyterlab_myst
pipuninstalljupyterlab_mystIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-mystwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyterlab_mystFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE