mkdocs-jupyterlite 0.1.1

Embed interactive JupyterLite notebooks in your MkDocs site.

mkdocs-jupyterlite

A MkDocs plugin that enables embedding interactive jupyterlite notebooks in your docs.

Say you have a notebook example.ipynb in your awesome project, and you want users to be able to play around with it. In the past, you could use a tool like Binder to achieve this. But, that requires a full docker environment and a remote server. By using JupyterLite, you can run Jupyter notebooks directly in the browser without any server-side dependencies.

However, to use jupyterlite, you have to manually install jupyterlite and then run a build step to package your notebooks, other files, and python dependencies into a single static site.

This plugin automates that process for you.

Installation

1. Install the plugin

pip install mkdocs-jupyterlite

2. Configure in your mkdocs.yml file

plugins:
  - search
  - mkdocstrings
  - etc
  - jupyterlite:
      enabled: true
      notebook_patterns:
        - "**/*.ipynb"

This doesn't currently support installing custom python packages into the JupyterLite environment, but this should be possible to support in the future.

Contributing

I want this to be usable for other people, so file an issue if you want to use this in your site, but run into any problems.