代码与Markdown目录扩展

JupyterLab 目录扩展，包括除了标题外的代码单元格和Markdown内容。

演示

代码单元格显示可以开启/关闭，Markdown单元格内容也是如此。目录条目也可以通过工具栏上的按钮按单元格元数据标签进行筛选。

要求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install jupyterlabcodetoc

卸载

要删除扩展，请执行

pip uninstall jupyterlabcodetoc

贡献

开发安装

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

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

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

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

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

jupyter lab build --minimize=False

开发模式下的卸载

pip uninstall jupyterlabcodetoc

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

测试扩展

前端测试

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

要执行它们，请执行

jlpm
jlpm test

集成测试

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

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

打包扩展

见RELEASE