🛠 Throughout the tutorial, whenever you're supposed to do something you will see a 🛠
See the video tutorial 📺
🛠 Install JupyterLab Locally
For this tutorial you must have installed JupyterLab locally (use a version greater than 3.0).
🛠 Install JupyterLab, following the guide at https://jupyter.org/install
Install JupyterLab MyST¶
pip install jupyterlab_myst
See the GitHub repository, jupyterlab-myst for full installation instructions.
🛠 Verify the installation
To verify that the extension is registered with Jupyter, use:
jupyter labextension list
You should see the following text in the output:
jupyterlab-myst v1.x.x enabled OK
Download quickstart content¶
We are going to download an example project that includes notebooks for use in JupyterLab with the MyST extension installed.
Our goal will be to try out some of the main features of
jupyterlab-myst, including frontmatter, MyST syntax, and inline execution.
🛠 Download the example content, and navigate into the folder:
git clone https://github.com/executablebooks/jupyterlab-myst-quickstart.git cd jupyterlab-myst-quickstart
Explore the Notebooks¶
More Coming Soon™
- showing frontmatter
- advanced user interface elements like tabs, grids, and cards
JupyterLab MyST allows you to create and evaluate inline expressions using the
These turn your markdown cells into places that you can quickly evaluate a simple expression, such as:
- The value of the variable
- Expand a sympy equation
Most widgets will work directly inline, allowing you to place widgets or controls inside of callouts, these can be linked together as normal.
The MyST extension also makes it very easy to edit task lists directly in the rendered view. Then you click a task item, the markdown is automatically updated.
For now, that's it for this quickstart tutorial, please see the content in the notebooks or help contribute to the docs to help document these features! Other tutorials to explore are:
Learn the basics of MyST Markdown, and export to a Word document, PDF, and !
See an overview of MyST Markdown syntax with inline demos and examples.