Skip to content

Latest commit

 

History

History
141 lines (92 loc) · 4.39 KB

README.md

File metadata and controls

141 lines (92 loc) · 4.39 KB
Raw

Jupyterlab Ariake Dark Theme

An ariake dark palette based JupyterLab theme extension.

updatebadge pypibadge mitbadge ci-badge

emailbadge

appearance

example 1

example 2

requirements

  • jupyterlab >= 4.0.0

install

to install the extension, execute:

pip install jupyterlab_ariakedark_theme

to check the installation, execute:

jupyter labextension list

uninstall

to remove the extension, execute:

pip uninstall jupyterlab_ariakedark_theme

contributing

to make personal customizations to the theme, edit the variables.css file, and then run the development install steps listed bellow.

feel free to make pending or other optimizations and pull requests, this theme is still under development and any contribution is very much appreciated.

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:
git clone https://github.com/eduardotlc/jupyterlab_ariakedark_theme
  • change directory to the jupyterlab_ariakedark_theme directory:
cd jupyterlab_ariakedark_theme
  • install package in development mode:
pip install -ve "."
  • 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_ariakedark_theme

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_ariakedark_theme within that folder.

Other themes

See my others Jupyter Lab themes

materialdarkerbadge

midnightseabadge