/jupyterlite-ext

Example JupyterLite repository using a custom Pyodide distribution

Primary LanguageJupyter Notebook

Custom JupyterLite Environment

Workflow

flowchart TD
    A{Custom packages?} -- Yes --> B[Build custom Pyodide distribution]
    A -- No --> C[Create a JupyterLite repo from the template]
    B --> C
    C --> D{Custom Pyodide environment?}
    D -- No --> E[Remove the default content]
    D -- Yes --> F[Create jupyter-lite.json referencing your Pyodide build]
    F --> E
    E --> G[Add your data and notebooks]
Loading

Steps

  1. Create a new repo using the JupyterLite template repository. Follow the instructions to make sure the GitHub Pages build process is set up and creating your new JupyterLite site.
  2. If you created or are using a custom Pyodide build, create a jupyter-lite.json configuration file at the top level of your new repository (see the example in this repo), e.g.,
{
  "jupyter-lite-schema-version": 0,
  "jupyter-config-data": {
    "litePluginSettings": {
      "@jupyterlite/pyodide-kernel-extension:kernel": {
        "pyodideUrl": "https://<your github pages domain?/pyodide-ext/pyodide.js"
      }
    }
  }
}
  1. Update the notebooks and data in the content folder. Remove the sample notebooks and data you don't need, and add your own.