cMadan / jupyter-themes

Custom Jupyter Notebook Themes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

jupyterthemes

Theme-ify your Jupyter Notebooks!

plots & equations

image

markdown & text cells

image

pandas dataframes

image

oceans16 syntax

image

grade3 syntax

image

onedork syntax

image

chesterish syntax

image

TravisCI Build status:

image

Interactive Binder Demo

Binder

Links

jupyterthemes on PyPI

jupyterthemes on GitHub

Install with pip

pip install jupyterthemes

Known Issues

  • UPDATE: lesscpy has added support for 3.5 to their development branch but still waiting for this to make it's way into the official release on pypi (opened an issue here). Soon hopefully...

  • jupyterthemes relies on lesscpy to compile the custom arguments supplied by the user into into the css body that eventually gets saved as custom.css in your jupyter config directory.

  • Unfortunately, lesscpy currently only supports up to Python 3.4. If you're running Python 3.5 you can still install and use jupyterthemes but you won't be able to modify the default settings (e.g., font, font-size, cell width, etc.). See Examples for 3.5 Users.

Command Line Usage

usage: jt [-h] [-l] [-t THEME] [-f MONOFONT] [-fs MONOSIZE] [-nf NBFONT]
          [-nfs NBFONTSIZE] [-tf TCFONT] [-tfs TCFONTSIZE] [-m MARGINS]
          [-cursw CURSORWIDTH] [-cursc CURSORCOLOR] [-cellw CELLWIDTH]
          [-lineh LINEHEIGHT] [-alt] [-vim] [-T] [-N] [-r]
options arg default
Usage help -h --
List Themes -l --
Theme Name to Install -t --
Code Font -f droidmono
Code Font-Size -fs 11
Notebook Font -nf exosans
Notebook Font Size -nfs 13
Text/MD Cell Font -tf ptserif
Text/MD Cell Fontsize -tfs 13
Intro Page Margins -m auto
Cell Width -cellw 980
Line Height -lineh 170
Cursor Width -cursw 2
Cursor Color -cursc --
Alt Text/MD Layout -alt --
Style Vim NBExt* -vim --
Toolbar Visible -T --
Name & Logo Visible -N --
Restore Default -r --
* Vim extension compatibility provided by alextfkd

Examples

# list available themes
# oceans16 | grade3 | chesterish | onedork
jt -l

# select theme...
jt -t chesterish

# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N

# set code font to 'Roboto Mono' 12pt
# (see monospace font table below)
jt -t oceans16 -f roboto -fs 12

# set code font to Fira Mono, 11.5pt
# 3digit font-size gets converted into float (115-->11.5)
jt -t grade3 -f fira -fs 115

# set notebook & text-cell/markdown fonts
# (see sans-serif & serif font tables below)
jt -t onedork -nf georgiaserif -tf droidsans

# adjust cell width, line-height of codecells
jt -t chesterish -cellw 900 -lineh 170

# fix the container-margins on the intro page (defaults to 'auto')
jt -t onedork -m 200

# adjust cursor width (in px) and color
# (options: b, o, r, p, g)
jt -t grade3 -alt -cursc r -cursw 5

# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N

# choose alternate txt/markdown layout
jt -t grade3 -alt

# restore default theme
jt -r

Examples for Python 3.5 users:

# install a theme
jt -t grade3
# list theme
jt -l
# reset theme
jt -r

Monospace Fonts (codecells)

-f arg Monospace Font
anka Anka/Coder
anonymous Anonymous Pro
aurulent Aurulent Sans Mono
bitstream Bitstream Vera Sans Mono
bpmono BPmono
code Code New Roman
consolamono Consolamono
cousine Cousine
dejavu DejaVu Sans Mono
droidmono Droid Sans Mono
fira Fira Mono
firacode Fira Code
generic Generic Mono
hack Hack
inconsolata Inconsolata-g
liberation Liberation Mono
meslo Meslo
office Office Code Pro
oxygen Oxygen Mono
roboto Roboto Mono
saxmono saxMono
source Source Code Pro
sourcemed Source Code Pro Medium
ptmono PT Mono
ubuntu Ubuntu Mono

Sans-Serif Fonts

-nf/-tf arg Sans-Serif Font
exosans Exo_2
opensans Open Sans
droidsans Droid Sans
latosans Lato
ptsans PT Sans
robotosans Roboto
sourcesans Source Sans Pro
amikosans Amiko
nobilesans Nobile
alegreyasans Alegreya
armatasans Armata
cambaysans Cambay
catamaransans Catamaran
franklinsans Libre Franklin
frankruhlsans Frank Ruhl
gothicsans Carrois Gothic
gudeasans Gudea
hindsans Hind
jaldisans Jaldi
makosans Mako
merrisans Merriweather Sans
mondasans Monda
oxygensans Oxygen Sans
pontanosans Pontano Sans
puritansans Puritan Sans
ralewaysans Raleway

Serif Fonts

-nf/-tf arg Serif Font
andadaserif Andada
arapeyserif Arapey
ptserif PT Serif
georgiaserif Georgia
cardoserif Cardo
crimsonserif Crimson Text
droidserif Droid Serif
ebserif EB Garamond
loraserif Lora
merriserif Merriweather
notoserif Noto Serif
vesperserif Vesper Libre
scopeserif ScopeOne
sanchezserif Sanchez
neutonserif Neuton
rasaserif Rasa
goudyserif Sorts Mill Goudy
vollkornserif Vollkorn

About

Custom Jupyter Notebook Themes

License:MIT License


Languages

Language:CSS 63.6%Language:Jupyter Notebook 27.6%Language:Python 8.8%