Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.64 KB

README.md

File metadata and controls

71 lines (47 loc) · 2.64 KB

Gruvbox Theme for Jupyter Lab

Build Status

Gruvbox dark theme for Jupyter Lab. Modeled on classic gruvbox color palette and gruvbox theme from jupyter-themes. Structure of this package is based on theme-dracula as this theme was developed from a fork of that repository.

Now compatible with JupyterLab 1.0!

gruvbox_preview

Prerequisites

  • Jupyter Lab version >= 1.0
  • node package manager (npm)

Installation

You do not need to clone this repository to install the theme. It is hosted on npm public registry. Clone only if you want to contribute to development.

Command line install

jupyter labextension install @rahlir/theme-gruvbox

GUI install

Alternatively, you can install the gruvbox theme using JupyterLab's new Extension Manager GUI, if you have it enabled. Just open the Extension Manager, enter @rahlir/theme-gruvbox in the search bar, and then follow the prompts to install.

You can find instructions for enabling the Extension Manager here. The Manager was only recently added, so you'll need to have a new enough version of JupyterLab (version 0.35.0 and above should have it for sure).

Keeping up to date

Note that this is still work in progress. Hence there might be bunch of updates coming out soon. To update the extension, run

jupyter labextension update @rahlir/theme-gruvbox

Scrollbars

Just as theme-dracula, this extension styles dark scrollbars on most web browsers.

From their readme:

With the latest release of Firefox (65), all of the major browsers except for one now support at least some styling of the native scrollbars. The only one left out at this point is Edge. If you're using Edge this theme will still work, but it won't give you the nice dark scrollbars.

See here and here for more info.

Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

npm install
jupyter labextension link .

To rebuild the package and the JupyterLab app:

npm run clean && npm run build
jupyter lab build