arbennett / jupyterlab-themes

More color themes for Jupyter Lab
GNU General Public License v3.0
190 stars 21 forks source link
jupyter jupyterlab jupyterlab-extension jupyterlab-theme themes

jupyterlab-themes

:wave: Hi there! As you can see I have not worked on this in a while - if somebody would like to take over maintaining this let me know!

Add more colors to your Jupyter Lab!

:exclamation: This plugin is in alpha stages. You are welcome to try to use and/or improve it, but stability is not guaranteed. If you want to help out, check out the contributing section below, or browse the issues!

What is this?

Simply put, this is an extension to add a number of color themes to Juptyer Lab. I created this as a heavy user of Jupyter Lab, and didn't particularly like the default dark scheme. I take heavy inspiration from the following projects:

Installation

Currently, you have to install each of the themes individually. Themes be installed directly via npm with the standard way of installing lab extensions:

jupyter labextension install @arbennett/base16-{$themename}

You can also install from source. This can be accomplished by running the following comands in a theme's respective subdirectory:

npm install
jupyter labextension link .

Example screenshots

Nord theme

nord

Mexico theme

mexico

Contributing

I am only able to work on this project intermittently, and would love to make this a community project. If you would like to contribute feel free to open a pull request or file an issue! I'll do my best to respond to PRs and issues as quickly as possible, and will probably prioritize that over doing more development of my own.

My workflow

Because I am not a web developer, my familiarity with javascript and typescript is somewhat limited. Thus, the workflow I've developed here may seem odd or convoluted to those with more experience in this domain. Basically, my workflow has been to edit the base stylesheets in the scss directory, and using the gen_css.sh script to generate all of the css files directly. Then I update my builds as necessary. If you know a better way to do this, please let me know!

Bumping versions

Because I have cobbled together a strange workflow for updating all of the themes at once it's a bit unwieldy to update the versioning consistently. This is the command I use (mostly for my own sake):

sed -i 's/"version": "CURRENT_VERSION"/"version": "NEW_VERSION"/g' ./**/package.json