Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 2.88 KB

README.md

File metadata and controls

99 lines (65 loc) · 2.88 KB
Raw

jupyterlab_add_logo

A frontend extension to add a top right logo.

NOTE: As mentionned in this com/jupyterlab/extension-examples issue, Jupyterlab v4 should provide a placeholder to customization simpler.

Overview

This jupyterlab extension allows to display an svg logo in the top right corner, as shown below for a custom logo.

light theme logo

dark theme logo

Replace the following files with your own logo and rebuild:

  • /style/logo/logo-dark.svg
  • /style/logo/logo-light.svg

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

# if/when published
pip install jupyterlab_add_logo

# else git clone repo and install locally from repo root folder
jlpm run build:prod
pip install .

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_add_logo

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_add_logo directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupyterlab_add_logo

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab_add_logo within that folder.

Packaging the extension

See RELEASE