Adds additional rendering support to markdown in JupyterLab by using markdown-it, and the following plugins:
- JupyterLab 2
Most custom markdown extensions not covered by the default
renderer (e.g. task lists, header anchors) will not work for others who do not
have this extension installed. Markdown is very lenient, so no data should be
lost, but it might look strange.
pip install jupyterlab_markup jupyter labextension install @agoose77/jupyterlab-markup
Ensure the extensions are enabled:
jupyter labextension list # should contain @goose/jupyterlab-markup jupyter serverextension list # should contain jupyterlab_markup
If the serverextension is missing, try...
jupyter serverextension enable jupyterlab_markup
After installing the extension (and restarting/reloading JupyterLab), all plugins will be enabled by default.
All plugins (and
markdown-it itself) can be disabled via the Command Palette
or under the
with Use Markdown Extensions. This will not affect existing renderers, so open
documents will need to be reopened.
Individual plugins can be previewed, enabled/disabled from the palette or menu under Markdown Extension Settings.... This view also provides links and examples of any features added by the extensions.
A number of settings can be configured through the JupyterLab Advanced Settings
Editor, including plugin and
markdown-it options. As with the above
limitations, heavy customization might make your documents look
Please see the contributor guide!
graph TD; A-->B; A-->C; B-->D; C-->D;
.---. /-o-/-- .-/ / /-> ( * \/ '-. \ \ / '