跳转到主要内容

A JupyterLab扩展,用于渲染Markdown中给出的表达式。

项目描述

jupyterlab_imarkdown

binder-badge pypi-badge

A JupyterLab扩展,用于在Markdown单元格中嵌入丰富的输出,例如。

The current value of x is {{ x }}

preview

技术细节

jupyterlab-imarkdown必须执行一些相当不愉快的事情,以便提供交互式Markdown。特别是,我们实现了自己的NotebookPanel.ContentFactory来注入我们的IMarkdownCell。此自定义类实现了检测Markdown单元格何时被渲染、跟踪特殊的eval-expr DOM节点以及用内核执行的结果更新这些DOM节点的例程。

需求

  • JupyterLab >= 3.0

安装

要安装扩展,执行

pip install jupyterlab_imarkdown

卸载

要删除扩展,执行

pip uninstall jupyterlab_imarkdown

贡献

开发安装

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

jlpm命令是JupyterLab安装的yarn的固定版本。您可以使用yarnnpm代替下面的jlpm

# Clone the repo to your local environment
# Change directory to the jupyterlab_imarkdown 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

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

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

在运行监视命令时,每次保存的更改都会立即在本地上构建并可用于您正在运行的JupyterLab。刷新JupyterLab以在浏览器中加载更改(您可能需要等待几秒钟,直到扩展重新构建)。

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

jupyter lab build --minimize=False

开发模式下的卸载

pip uninstall jupyterlab_imarkdown

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

打包扩展

请参阅 RELEASE

项目详情


下载文件

下载适合您平台版本的文件。如果您不确定选择哪个版本,请了解有关 安装包 的更多信息。

源分布

jupyterlab_imarkdown-0.2.0.tar.gz (135.3 kB 查看哈希值)

上传时间

构建分布

jupyterlab_imarkdown-0.2.0-py3-none-any.whl (667.2 kB 查看哈希值)

上传时间 Python 3

支持者