transcranial/jupyter-themer

Apply custom CSS styling to your jupyter notebooks

jupyter-themer

Apply custom CSS styling to your jupyter notebooks. Contributions are welcome!

Mix and match themes by:

• layout (example: wide)

• typography (example: serif)

• color (example: night)

You can always revert back to the default:

Installation

pip install jupyter-themer

or

python setup.py install

Usage

NOTE: Old ipython configuration files, for example at the default ~/.ipython, may need to be removed in order for jupyter to use the correct files.

usage: jupyter-themer [-c COLOR, --color COLOR]
                      [-l LAYOUT, --layout LAYOUT]
                      [-t TYPOGRAPHY, --typography TYPOGRAPHY]
                      [-f CODE_FONT, --font CODE_FONT]
                      [-b BACKGROUND, --background BACKGROUND]
                      [-s OPTION, --show OPTION]
                      [-p PATH, --css_path PATH]

If no arguments are supplied, the program will revert the jupyter notebook style back to default.

Any combination of the style types can be specified, and the program will mix together the associated color/layout/typographic/code font/background css files accordingly, writing it to the custom.css file used by the notebook. Use -p or --css_path to specify a custom path for the css file, for example if you need per-user configuration.

To get a list of available options use the show argument, e.g. jupyter-themer --show color

For all running notebooks, a quick browser refresh will be needed to apply the stylesheet.

Available themes

-c, --color

• 3024-day
• 3024-night
• abcdef
• ambiance
• base16-dark
• base16-light
• blackboard
• cobalt
• colorforth
• dracula
• eclipse
• elegant
• erlang-dark
• icecoder
• lesser-dark
• liquibyte
• material
• mbo
• mdn-like
• midnight
• monokai
• neat
• neo
• night
• paraiso-dark
• paraiso-light
• pastel-on-dark
• rubyblue
• seti
• solarized-light
• solarized-dark
• the-matrix
• tomorrow-night-bright
• tomorrow-night-eighties
• ttcn
• twilight
• vibrant-ink
• xq-dark
• xq-light
• yeti
• zenburn

-l, --layout

• wide
• hovertable

-t, --typography

• serif

-f, --font

• Ubuntu_Mono

-b, --background

• dark

License

MIT License

jupyter-themer's Issues

Add wiki page with image for themes

It would be nice to see what the available options look like.

jupyter-themer not available on pip

README says that jupyter-themer can be installed using pip by:

pip install jupyter-themer

but this give the following error, both on python 3 and python 2:

Could not find a version that satisfies the requirement jupyter-themer (from versions: )
No matching distribution found for jupyter-themer

Searching the package on PyPI #1 also gives no result.

Full Example Request

Hey. This looks really good and I'm really interesting in using but it isn't clear to me how to use the thing.

Can you include a simple worked example the readme? Thanks in advance.

Jacob

odd TR are not dark in dark themes

this css selector appears to be off:

.rendered_html tbody tr:nth-child(odd)

Dark cursor in dark themes

Hi, great utility! But there's a problem with dark themes at least on Ubuntu Gnome 15.10 and Chrome: the cursor stays dark as well, so it's impossible to edit. Also the background around the cells stays white - is it normal?

How to not disable the outer scrollbar?

It seems that jupyter-themer disables the outermost vertical scrollbar in jupyter (in the extreme right). See below how things look when the problem is NOT present.

That bar was created inserting this code on custom.js:

.container{ width:100% !important; }
div#site{ height: 100% !important; }

I can't get it back even with jt -r (I solved it reinstalling the notebook). And this bar is very useful in hiding the menus.
Running on notebook 4.2, firefox 48, ubuntu-gnome 16.04.

Besides this, jupyter-themer is awesome!

Available typographies

Would it be possible to introduce other examples of the available typographies?

Add differentiation between solarized-light and solarized-dark

It appears there is CSS in there to enable the dark version, but I cant figure out for the life of me what needs to be done to enable it instead of the light default.

Nice!

Works very well. Thank you for doing this.

Symbols are hard to see in Monokai

Using the Monokai theme renders the symbols:
= , [ ] ( )
extremely hard to see.

They are dark blue by default, which is fine against a white background, but near unreadable against the dark Monokai background.

I am working with Python 3 on Win10_64 and Linux 64. Here is an example:

Theme doesn't make effect

Hello,

Thank you very much for the nice work.

I tried using the jupyter-themer to set a Theme in my Jupyter Notebook but it actually had no effect.

I tried doing this: " Old ipython configuration files, for example at the default ~/.ipython, may need to be remove" but I actually do not know where to find this.

I also tried what is mentioned in #5 of replacing the custom.css by the theme I want. I did this but I do not know if I replaced it in the right place, I did it in the following directory: anaconda3/lib/python3.6/site-packages/notebook/static/custom

Could you please help me make this work ?

Thanks :)

No Effect

Hi,

first of all thanks for your efforts. Unfortunately, the themer does not work for me (ipython 4.0, jupyter 1.0) . I tried deleting ipython files, but whenever I relaunch jupyter notebook, a folder profile_default is automatically created in .ipython again.
Do you have an idea how to fix this?

More Verbose Error Messages

Your project looks very interesting, and I was glad to test it out. Unfortunately, I got an error: "Error writing to custom.css". From this message, though, I don't know exactly what's wrong. Is it an issue with file permissions? I'm able to edit the file myself, so I wouldn't expect that. Does it not find the file? I have it in the normal location (~/.jupyter/custom/custom.css). I get the error whether or not custom.css already exists.

It would be nice to have an error message that let me know exactly what the issue was so I can troubleshoot it more effectively. Thanks!

Bad argument passed to --font/--typography

I'm trying to change the fonts used by Jupyter Notebook using the --font and --typography arguments in jupyter-themer but no matter what arguments I give it, I keep getting a 'Bad argument passed to --font/--typography. Have a look at the screenshot I've attached.

The arguments I'm passing appear to be valid according to jupyter-themer's --show helper so I'm confused why they generate errors. What am I doing wrong?

How do you use this?

Love the idea.

It's not entirely clear how to use it.

I did something like this, but this had no effect.

from jupythemer import jupythemer

class Object(object):
    pass

args = Object()
args.layout     = 'wide'
args.color      = None
args.typography = None

jupythemer.run(args)

typography

Hi,

I get typography not supported error when I use -t serif option while changing the theme

Thanks