https://github.com/transcranial/jupyter-themer

Apply custom CSS styling to your jupyter notebooks
https://github.com/transcranial/jupyter-themer

jupyter-notebook

Last synced: 13 days ago
JSON representation

Apply custom CSS styling to your jupyter notebooks

• Host: GitHub
• URL: https://github.com/transcranial/jupyter-themer
• Owner: transcranial
• License: mit
• Created: 2015-04-15T12:47:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-22T19:04:32.000Z (about 6 years ago)
• Last Synced: 2024-10-13T02:40:58.865Z (about 1 month ago)
• Topics: jupyter-notebook
• Language: Python
• Homepage:
• Size: 994 KB
• Stars: 329
• Watchers: 13
• Forks: 55
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jupyter-themer

![https://travis-ci.org/transcranial/jupyter-themer](https://travis-ci.org/transcranial/jupyter-themer.svg?branch=master) ![https://pypi.python.org/pypi/jupyter-themer/0.1.0](https://img.shields.io/pypi/v/jupyter-themer.svg)

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

Mix and match themes by:

- layout (example: `wide`)

![layout](images/layout.png)

- typography (example: `serif`)

![typography](images/typography.png)

- color (example: `night`)

![color](images/color.png)

You can always revert back to the default:

![default](images/default.png)

### Installation

```sh

pip install jupyter-themer

```

or

```sh

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.

```sh

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