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

提示

如果您想先熟悉界面,请查看用户指南

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

注意

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

从模板生成新存储库#

jupyterlite 演示存储库是一个模板,可以轻松

  • 使用预构建的 JupyterLite 资产捆绑预先存在的 Jupyter Notebook 集合作为分发的一部分来构建 JupyterLite 网站

  • 将网站部署到 GitHub Pages

该过程通过 Github Actions 自动化。

点击“使用此模板”从此模板生成您自己的存储库

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

在存储库的Actions选项卡中,确保工作流已启用。当您向main分支进行提交时,Github Action 将构建您的 JupyterLite 版本并将其部署到存储库的 Github Pages。默认情况下,Github Pages 站点将在YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME找到。您还可以从存储库Settings选项卡Pages菜单项中查看 URL。

如果部署失败,请转到“设置 - 操作 - 通用”,在“工作流权限”部分,勾选“读写权限”。检查您是否已为存储库启用 Github Pages:从存储库的 Settings 选项卡中,选择 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 文件可用于向部署的 JupyterLite 网站添加额外的预构建(也称为联合)JupyterLab 扩展。请遵循扩展指南了解更多信息。

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

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

通过预安装包,它们可以在内核中直接使用,无需piplite即可导入。

内容#

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

请查看关于管理内容的指南以了解更多信息。

更多信息#

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