jupyterlab_rise

RISE：Reveal.js JupyterLab 演示文稿扩展。

要求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install jupyterlab_rise

对于JupyterLab 3.x，安装版本在0.40.0之前

pip install "jupyterlab_rise<0.40.0"

卸载

要删除扩展，请执行

pip uninstall jupyterlab_rise

故障排除

如果您看到前端扩展但无法工作，请检查服务器扩展是否启用

jupyter server extension list

如果服务器扩展已安装并启用，但您看不到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

贡献

开发安装

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

jlpm 命令是 JupyterLab 安装时附带安装的 yarn 的固定版本。您可以使用 yarn 或 npm 替代 jlpm。

# Clone the repo to your local environment
# Change directory to the jupyterlab_rise directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_rise
# 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

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

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

jupyter lab build --minimize=False

开发模式卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_rise
pip uninstall jupyterlab_rise

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

测试扩展

集成测试

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

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

打包扩展

请参阅 RELEASE