How-To Guides

Note

This set of how-to guides is geared towards creating and configuring a custom JupyterLite website at build time.

To learn more about using an already deployed JupyterLite website, check out the Quickstart Guide. More how-to guides on using and configuring an existing JupyterLite website at runtime (focused on accessing content, working with settings) will soon be added.

Configuring a JupyterLite deployment

A JupyterLite website can be configured in many ways, and reuse many of the existing tools and extensions from the Jupyter ecosystem.

• Adding kernels
• Adding extensions
• Configure the browser storage
• Customizing Settings
• Localization and language
• Enable Real Time Collaboration
• Configuring jupyter_lite_config.json, jupyter-lite.json and overrides.json
• Enable switching between the JupyterLab and Notebook interfaces

Contents

• Adding content: notebook, files and static assets
• Accessing files and notebooks from a kernel
• Accessing local files
• Opening a file from an external URL
• Sharing a link to a file

Configuring the Pyodide kernel

• Use additional Python packages
• Ship additional Pyodide wheels at build time
• Using a custom Pyodide distribution

Configuring the Xeus Python kernel

• Pre-install additional packages with emscripten-forge

Deploying

• Deploy your first JupyterLite website on GitHub Pages
• Making changes to a JupyterLite website hosted on GitHub Pages
• Deploying on ReadTheDocs with jupyterlite-sphinx
• Deploying on Vercel and Netlify
• Deploying on GitLab Pages
• Deploying on Binder with jupyter-server-proxy

Extensions

JupyterLite uses the same extension system as in JupyterLab, and can be extended to add more features and plugins, such as frontend extensions and new kernels.

• Create a new frontend extension
• Create a server extension
• Create a custom kernel
• Create a new addon to extend the CLI

Advanced configuration

• Optimizations
• Create a JupyterLite archive that can be used offline
• Communication between a host page and a JupyterLite instance running in an IFrame
• Advanced extension configuration
• ServiceWorker
• The Hard Way