README.md

JupyterLab PDF Preview

JupyterLab extension to preview PDF files in the file browser on hover.

Installation

Install the latest version of JupyterLab PDF Preview using pip:

pip install -U jupyterlab-pdf-preview

This extension should run alongside JupyterLab version 4.

Development

To develop, the following dependencies must be installed:

• Python
• Hatch
• Node.js

To build the extension and start up a JupyterLab server for development, run:

hatch run dev

When the source code changes, the extension should be automatically rebuilt, and the updated extension will be used when the page is reloaded.

Note

On Windows, symbolic links must be activated for hatch run dev to work. On Windows 10 or above, this can be done by activating developer mode.

Alternatively, you can run

hatch run clean
hatch env remove default
hatch run jupyter lab

to completely reinstall the extension and start JupyterLab each time the source code changes.