在 GitHub Pages 上部署你的第一个 JupyterLite 网站#

提示

如果你想先熟悉一下界面,请查看 用户指南.

JupyterLite 可以轻松地部署在 GitHub Pages 上,使用 jupyter-lite CLI 添加内容和扩展。

注意

部署到 GitHub Pages 需要一个 Github 帐户。

从模板生成一个新的仓库#

jupyterlite 演示 仓库是一个模板,可以轻松地

  • 使用预构建的 JupyterLite 资产构建一个 JupyterLite 网站,这些资产捆绑了一组预先存在的 Jupyter 笔记本,作为分发的一部分

  • 将网站部署到 GitHub Pages

该过程使用 Github Actions 自动化。

点击“使用此模板”从该模板生成你自己的仓库

an animated gif to show how to use the provide repo template to generate a new website

在你的仓库的“操作”选项卡中,确保工作流已启用。当你对 main 分支进行提交时,一个 Github Action 将构建你的 JupyterLite 版本并将其部署到仓库的 Github Pages。默认情况下,Github Pages 网站将在 YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME 处找到。你也可以从仓库的“设置”选项卡的“页面”菜单项中查看 URL。

如果部署失败,请转到“设置 - 操作 - 常规”,在“工作流权限”部分,选中“读写权限”。检查你的仓库是否启用了 Github Pages:从你的仓库“设置”选项卡中,选择“页面”菜单项,并确保源设置为 GitHub Actions

a screenshot showing the GitHub Actions configuration option for deploying to GitHub Pages

当你提交文件时,一个更新的网站将被构建并发布在 Github Pages 上。

注意

请注意,Github Pages 网站可能需要几分钟才能更新。在你的网络浏览器中对你的 Github Pages 网站进行硬刷新,以查看网站的新版本。

注意

或者,你可以使用 使用 xeus-python 的 JupyterLite 演示 在 Github Pages 上发布一个部署,该部署默认使用 xeus-python,并允许使用 emscripten-forgeconda-forge 预安装软件包。

访问 JupyterLite 网站#

构建完成后,该网站将在 GitHub Pages 上可用。转到 https://YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME 访问它

an animated screencast of using a JupyterLite website on GitHub Pages

注意

默认情况下,jupyterlite/demo 仓库提供的部署包含一个 .nojekyll 文件,以绕过 GitHub Pages 上的 Jekyll 处理。

有关更多信息,请参见此 博客文章

部署新版本的 JupyterLite#

要更改预构建的 JupyterLite 资源的版本,请在 requirements.txt 文件中更新 jupyterlite-core 包的版本。

提交并推送更改。该站点将在下次推送到 main 分支时部署。

向部署添加其他要求#

注意

jupyterlite/demo 存储库使用 requirements.txt 文件来指定依赖项。出于演示目的,此文件可能包含您可能希望从部署中删除的额外内核和扩展。如果是这种情况,您可以坚持使用更简洁的 requirements.txt 文件,例如

# core package for building the JupyterLite website
jupyterlite-core==0.1.0b19
# the Python kernel powered by Pyodide
jupyterlite-pyodide-kernel==0.0.5
# dependency for indexing the content
jupyterlab~=3.5.3

扩展#

requirements.txt 文件可用于将额外的预构建(也称为联合)JupyterLab 扩展添加到已部署的 JupyterLite 网站。请遵循 扩展指南 以了解更多信息。

使用 xeus-python 内核和 emscripten-forge#

使用 带有 xeus-python 的 JupyterLite 部署,您可以通过将它们指定到 environment.yml 文件中来预安装在 conda-forgeemscripten-forge 上都可用的软件包。

通过预安装软件包,它们可以在内核中轻松使用,并且可以导入而无需使用 piplite

内容#

您可以通过单击 contents 目录并将笔记本从桌面拖放到内容列表中来添加和更新默认笔记本和文件。等待文件上传,然后保存它们(将它们提交)到存储库的 main 分支。

查看有关 管理内容 的操作指南以了解更多信息。

更多信息#

如果您想自定义 JupyterLite 网站,请查看不同的 操作指南