steffo/jupyterlab-theme-sophon
1
Fork 0
mirror of https://github.com/Steffo99/jupyterlab-theme-sophon.git synced 2024-11-21 15:44:29 +00:00
Code Activity
Sophon theme for JupyterLab
2 commits 4 branches 1 tag 173 KiB
CSS 73.5%
Python 22.8%
TypeScript 3.7%
Find a file
Stefano Pigozzi 16ad7a02bd
Create the theme
2021-09-01 04:12:51 +02:00
.github/workflows First commit 2021-09-01 01:31:14 +02:00
binder First commit 2021-09-01 01:31:14 +02:00
jupyterlab_theme_sophon First commit 2021-09-01 01:31:14 +02:00
src Create the theme 2021-09-01 04:12:51 +02:00
style Create the theme 2021-09-01 04:12:51 +02:00
.eslintignore First commit 2021-09-01 01:31:14 +02:00
.eslintrc.js First commit 2021-09-01 01:31:14 +02:00
.gitignore First commit 2021-09-01 01:31:14 +02:00
.prettierignore First commit 2021-09-01 01:31:14 +02:00
.prettierrc First commit 2021-09-01 01:31:14 +02:00
install.json First commit 2021-09-01 01:31:14 +02:00
LICENSE First commit 2021-09-01 01:31:14 +02:00
MANIFEST.in First commit 2021-09-01 01:31:14 +02:00
package.json First commit 2021-09-01 01:31:14 +02:00
pyproject.toml First commit 2021-09-01 01:31:14 +02:00
README.md First commit 2021-09-01 01:31:14 +02:00
setup.py First commit 2021-09-01 01:31:14 +02:00
tsconfig.json First commit 2021-09-01 01:31:14 +02:00
yarn.lock Create the theme 2021-09-01 04:12:51 +02:00

README.md

jupyterlab_theme_sophon

Github Actions Status

Sophon theme for JupyterLab

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_theme_sophon

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_theme_sophon 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 run 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 run 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 run 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

Uninstall

pip uninstall jupyterlab_theme_sophon
jupyter labextension uninstall jupyterlab_theme_sophon