Repolode
timkpaine

timkpaine/jupyterlab-iframe

一个 JupyterLab 扩展,可在 iframe 组件中打开网站或本地 HTML 文件,并可添加快捷入口。

Star
118
Fork
22
未关闭 Issue
4
最近提交
6天前

这是什么?

jupyterlab_iframe 让 JupyterLab 用户无需离开笔记本环境,即可在嵌入的 iframe 面板中查看网页和本地 HTML 文件。站点通过 Jupyter 配置文件中的列表定义,每项的 path 可以是 http 或 https 地址,也可以是指向本地磁盘 HTML 文件的 local:// 路径。

每个站点可设置为 JupyterLab 首次加载时自动打开,适合用作首页;也可以在启动器中添加一个入口图标,图标可使用自定义 URL,未设置时使用站点的 favicon。默认情况下可通过 local:// 打开任意本地文件,将 allow_any_local 设为 False 则只允许访问明确列出的站点。

该项目通过 pip 安装,并需要同时启用 labextension 和 server extension。它也可用于 Binder 环境,在启动时展示一个着陆页。

核心功能

  • 01在 JupyterLab 的 iframe 组件中嵌入网页和本地 HTML 文件。
  • 02通过配置列表定义站点,可设置启动时自动打开和启动器入口。
  • 03支持自定义启动器图标,未设置时使用站点 favicon。
  • 04可将本地文件访问限制在明确列出的站点范围内。

适用场景

  • 在 notebook 旁边保持项目仪表盘或文档页面打开。
  • 在 Binder 环境启动时展示着陆页或使用说明。
  • 在 JupyterLab 内打开本地 HTML 报告或可视化结果。

快速上手

  1. 1

    安装 Python 包

    pip install jupyterlab_iframe
  2. 2

    安装 JupyterLab 扩展

    jupyter labextension install jupyterlab_iframe
  3. 3

    启用服务端扩展

    jupyter serverextension enable --py jupyterlab_iframe
  4. 4

    在 jupyter_notebook_config.py 中添加站点列表

使用前须知

  • 默认情况下,可通过 local:// 协议打开文件系统上的任何本地文件,除非将 allow_any_local 设为 False。
  • README 中的安装步骤使用较旧的 labextension 和 serverextension 命令,可能与当前版本的 JupyterLab 不匹配。

标签

常见问题

jupyterlab-iframe 是什么?
一个 JupyterLab 扩展,可在 iframe 组件中打开网站或本地 HTML 文件,并可添加快捷入口。 jupyterlab_iframe 让 JupyterLab 用户无需离开笔记本环境,即可在嵌入的 iframe 面板中查看网页和本地 HTML 文件。站点通过 Jupyter 配置文件中的列表定义,每项的 path 可以是 http 或 https 地址,也可以是指向本地磁盘 HTML 文件的 local:// 路径。
jupyterlab-iframe 可以免费使用吗?用的什么许可证?
jupyterlab-iframe 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
jupyterlab-iframe 还在维护吗?
活跃维护中。jupyterlab-iframe 最近一次提交是在 2026年11月2日。
jupyterlab-iframe 适合用来做什么?
在 notebook 旁边保持项目仪表盘或文档页面打开。 在 Binder 环境启动时展示着陆页或使用说明。 在 JupyterLab 内打开本地 HTML 报告或可视化结果。
jupyterlab-iframe 怎么安装和运行?
安装 Python 包: pip install jupyterlab_iframe 安装 JupyterLab 扩展: jupyter labextension install jupyterlab_iframe 启用服务端扩展: jupyter serverextension enable --py jupyterlab_iframe 在 jupyter_notebook_config.py 中添加站点列表
在哪里获取 jupyterlab-iframe?
源代码和安装说明在 GitHub 上:https://github.com/timkpaine/jupyterlab-iframe

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目