jupyterlab_mystjs

使用MyST Markdown渲染Markdown单元格

需求

• JupyterLab >= 3.0

安装

要安装扩展，请执行

pip install jupyterlab_mystjs

用法

默认情况下，MyST渲染器成为默认的笔记本渲染器。这意味着MyST笔记本渲染可以与Jupytext和其他笔记本感知扩展无缝工作。虽然此扩展处于预发布状态，但还有一个“旧版模式”，将MyST渲染作为额外的“打开方式”选项进行集成，而不替换默认的笔记本渲染器。要启用旧版模式，请使用以下命令禁用jupyterlab-mystjs:plugin插件：

jupyter labextension disable jupyterlab-mystjs:plugin

卸载

要删除扩展，请执行

pip uninstall jupyterlab_mystjs

贡献

开发安装

注意：您需要NodeJS来构建扩展包。

jlpm命令是JupyterLab与JupyterLab一起安装的yarn的固定版本。您可以使用yarn或npm替代以下jlpm。

# Make sure jupyterlab is up to date
conda update jupyterlab
# Clone the repo to your local environment
# Change directory to the cloned jupyterlab-mystjs 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

您可以在不同的终端中同时监视源目录并运行JupyterLab，以监视扩展源中的更改并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

在运行watch命令时，每次保存的更改都会立即本地构建并可在您运行的JupyterLab中可用。刷新JupyterLab以在浏览器中加载更改（您可能需要等待几秒钟以重建扩展）。

默认情况下，jlpm build命令为此扩展生成源映射，以便使用浏览器开发者工具进行调试。要同时生成JupyterLab核心扩展的源映射，可以运行以下命令

jupyter lab build --minimize=False

开发模式卸载

pip uninstall jupyterlab_mystjs

在开发模式下，您还需要删除由jupyter labextension develop命令创建的符号链接。要找到其位置，可以运行jupyter labextension list以确定labextensions文件夹的位置。然后您可以删除该文件夹中名为jupyterlab-mystjs的符号链接。

测试扩展

前端测试

此扩展使用Jest进行JavaScript代码测试。

要执行它们，请执行

jlpm
jlpm test

集成测试

此扩展使用Playwright进行集成测试（也称为用户级测试）。更确切地说，JupyterLab助手Galata用于处理在JupyterLab中测试扩展。

更多详细信息请参阅ui-tests的README。

打包扩展

请参阅RELEASE