solarized/README.md

412 lines
20 KiB
Markdown
Raw Normal View History

---
2011-04-14 23:53:26 +00:00
title: Solarized
description: Precision colors for machines and people
author: Ethan Schoonover
tags: test, testing, test123
colors: light yellow
created: 2011 Mar 15
modified: 2011 Apr 16
---
2011-03-26 07:24:57 +00:00
Solarized
=========
2011-03-18 21:46:09 +00:00
2011-03-26 07:24:57 +00:00
## Precision colors for machines and people
2011-03-23 06:35:16 +00:00
2012-08-28 06:53:31 +00:00
[![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-yinyang.png)](#features)
2011-03-19 05:06:23 +00:00
2012-08-13 06:50:18 +00:00
Solarized is a sixteen color palette (eight monotones, eight accent colors)
designed for use with terminal and gui applications. It has several [unique
properties](#features). I designed this colorscheme with both precise
[CIELAB](http://en.wikipedia.org/wiki/Lab_color_space) lightness relationships
and a refined set of hues based on fixed color wheel relationships. It has been
tested extensively in real world use on color calibrated displays (as well as
uncalibrated/intentionally miscalibrated displays) and in a variety of lighting
2011-03-26 07:24:57 +00:00
conditions.
2011-03-20 02:50:57 +00:00
2011-04-16 17:39:56 +00:00
***See the [changelog] for what's new in the most recent release.***
2012-08-28 06:53:31 +00:00
![solarized palette](https://github.com/altercation/solarized/raw/master/img/solarized-palette.png)
![solarized vim](https://github.com/altercation/solarized/raw/master/img/solarized-vim.png)
2011-03-19 04:36:34 +00:00
2011-03-26 07:24:57 +00:00
Currently available in formats for (cf [screenshots](#screenshots) below):
2011-03-18 21:53:58 +00:00
### Editors & IDEs
* **Vim** by [me](https://github.com/altercation) (the Vim-only portion of Solarized is
2012-08-13 06:50:18 +00:00
[available here](https://github.com/altercation/vim-colors-solarized), for use with
Pathogen, etc.). See also the [Vim README](http://ethanschoonover.com/solarized/vim-colors-solarized).
* **Emacs** courtesy of [Greg Pfeil](http://blog.technomadic.org)
([@sellout](http://twitter.com/sellout))
2011-04-15 06:57:28 +00:00
in the main repo and in a [standalone repository][Emacs Repository]
* **IntelliJ IDEA**
courtesy of [Johan Kaving](https://github.com/jkaving) and
([@flangy](http://twitter.com/flangy))
in the main repo and in a [standalone repository][IntelliJ Repository]
* **NetBeans** courtesy of [Brian Fenton](https://github.com/fentie) and
in the main repo and in a [standalone repository][NetBeans Repository]
* **SeeStyle theme for Coda & SubEthaEdit** courtesy of
2012-08-13 06:50:18 +00:00
[Justin Hileman](http://justinhileman.com/)
([@bobthecow](http://twitter.com/bobthecow)),
2011-04-15 06:57:28 +00:00
in the main repo and in a
[standalone repository][SeeStyle-Coda-SubEthaEdit Repository]
2011-04-16 23:01:56 +00:00
* **TextMate** --- ***NOTE:*** Dark Theme is work in progress\
2012-08-13 06:50:18 +00:00
courtesy of [Tom Martin](http://thedeplorableword.net/)
([@deplorableword](http://twitter.com/deplorableword))
in the main repo and in a [standalone repository][TextMate Repository]
2012-08-13 06:50:18 +00:00
(with key work from [Mark Story](http://mark-story.com)
2011-04-16 17:39:56 +00:00
and [Brian Mathiyakom](http://brian.rarevisions.net))
* **TextWrangler & BBEdit** courtesy of [Rui Carmo](http://the.taoofmac.com)
([@taoofmac](http://twitter.com/taoofmac))
in the main repo and in a [standalone repository][TextWrangler-BBEdit Repository]
2012-08-13 06:50:18 +00:00
* **Visual Studio** courtesy of [David Thibault](http://www.leddt.com)
([@leddt](http://twitter.com/leddt))
2011-04-15 06:57:28 +00:00
in the main repo and in a [standalone repository][Visual Studio Repository]
2012-08-13 06:50:18 +00:00
* **Xcode** work in progress ports are available for [Xcode 3] and [Xcode 4]
and will be pulled into the main Solarized project soon.
### Terminal Emulators
2011-04-16 17:39:56 +00:00
2011-03-26 07:24:57 +00:00
* **Xresources** / Xdefaults
* **iTerm2**
* **OS X Terminal.app**
2011-04-14 22:40:05 +00:00
* **Putty** courtesy [Brant Bobby](http://www.control-v.net)
and on [GitHub](https://github.com/brantb)
2011-04-16 17:39:56 +00:00
### Other Applications
* **Mutt** e-mail client also by [me] (*just* the Mutt colorscheme is
[available here][Mutt Repository])
### Palettes
* **Adobe Photoshop** Palette (inc. L\*a\*b values)
* **Apple Color Picker** Palettes
* **GIMP** Palette
2011-03-26 07:24:57 +00:00
2012-08-13 06:50:18 +00:00
Don't see the application you want to use it in? Download the palettes (or pull
the values from the table below) and create your own. Submit it back and I'll
happily note the contribution and include it on this page. See also the
[Usage & Development](#usage-development) section below for details on the
specific values to be used in different contexts.
2011-03-26 07:24:57 +00:00
Download
--------
### [Click here to download latest version](http://ethanschoonover.com/solarized/files/solarized.zip)
2012-08-13 06:50:18 +00:00
Current release is **v1.0.0beta2**. See the [changelog] for details on what's
2011-04-16 17:39:56 +00:00
new in this release.
### Fresh Code on GitHub
2011-03-26 07:24:57 +00:00
2012-08-13 06:50:18 +00:00
You can also use the following links to access application specific downloads
and git repositories:
2011-03-26 07:24:57 +00:00
* **Canonical Project Page:**
Downloads, screenshots and more information are always available from the
project page: <http://ethanschoonover.com/solarized>
* **Full Git Repository:**
2011-03-26 07:24:57 +00:00
The full git repository is at: <https://github.com/altercation/solarized>
Get it using the following command:
$ git clone git://github.com/altercation/solarized.git
* **Application Specific Repositories:**
2011-03-26 07:24:57 +00:00
2012-08-13 06:50:18 +00:00
You can clone repositories specific to many of the application specific
color themes. See links in the list above or select from this list:
2011-03-26 07:24:57 +00:00
* [Vim Repository]
* [Mutt Repository]
* [Emacs Repository]
* [IntelliJ Repository]
* [NetBeans Repository]
* [SeeStyle-Coda-SubEthaEdit Repository]
* [TextMate Repository]
* [TextWrangler-BBEdit Repository]
* [Visual Studio Repository]
2011-03-26 07:24:57 +00:00
2011-04-16 17:39:56 +00:00
* [Xcode 3 work in progress][Xcode 3]
* [Xcode 4 work in progress][Xcode 4]
Note that through the magic of [git-subtree](https://github.com/apenwarr/git-subtree)
these repositories are all kept in sync, so you can pull any of them and get the most up-to-date version.
2011-03-26 07:24:57 +00:00
Features
--------
1. **Selective contrast**
2012-08-13 06:50:18 +00:00
On a sunny summer day I love to read a book outside. Not right in the sun;
that's too bright. I'll hunt for a shady spot under a tree. The shaded
paper contrasts with the crisp text nicely. If you were to actually measure
the contrast between the two, you'd find it is much lower than black text
2011-03-26 07:24:57 +00:00
on a white background (or white on black) on your display device of choice.
2012-08-13 06:50:18 +00:00
Black text on white from a computer display is akin to reading a book in
2011-03-26 07:24:57 +00:00
direct sunlight and tires the eye.
2012-08-28 06:53:31 +00:00
![solarized selective contrast](https://github.com/altercation/solarized/raw/master/img/solarized-selcon.png)
2011-03-26 07:24:57 +00:00
2012-08-13 06:50:18 +00:00
Solarized reduces *brightness contrast* but, unlike many low contrast
colorschemes, retains *contrasting hues* (based on colorwheel relations)
2011-03-26 07:24:57 +00:00
for syntax highlighting readability.
2. **Both sides of the force**
2012-08-28 06:53:31 +00:00
![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-dualmode.png)
2011-03-26 07:24:57 +00:00
I often switch between dark and light modes when editing text and code.
2012-08-13 06:50:18 +00:00
Solarized retains the same selective contrast relationships and overall
feel when switching between the light and dark background modes. A *lot* of
thought, planning and testing has gone into making both modes feel like
2011-03-26 07:24:57 +00:00
part of a unified colorscheme.
3. **16/5 palette modes**
2012-08-28 06:53:31 +00:00
![solarized palettes](https://github.com/altercation/solarized/raw/master/img/solarized-165.png)
2011-03-26 07:24:57 +00:00
Solarized works as a sixteen color palette for compatibility with common
2012-08-13 06:50:18 +00:00
terminal based applications / emulators. In addition, it has been carefully
designed to scale down to a variety of five color palettes (four base
2011-03-26 07:24:57 +00:00
monotones plus one accent color) for use in design work such as web design.
In every case it retains a strong personality but doesn't overwhelm.
5. **Precision, symmetry**
2012-08-28 06:53:31 +00:00
![solarized symmetry](https://github.com/altercation/solarized/raw/master/img/solarized-sym.png)
2011-03-26 07:24:57 +00:00
2012-08-13 06:50:18 +00:00
The monotones have symmetric CIELAB lightness differences, so switching
from dark to light mode retains the same perceived contrast in brightness
between each value. Each mode is equally readable. The accent colors are
based off specific colorwheel relations and subsequently translated to
CIELAB to ensure perceptual uniformity in terms of lightness. The hues
themselves, as with the monotone \*a\*b values, have been adjusted within
2011-03-26 07:24:57 +00:00
a small range to achieve the most pleasing combination of colors.
2012-08-13 06:50:18 +00:00
See also the [Usage & Development](#usage-development) section below for
details on the specific values to be used in different contexts.
2012-08-13 06:50:18 +00:00
This makes colorscheme inversion trivial. Here, for instance, is a sass
(scss) snippet that inverts solarized based on the class of the html tag
2011-03-26 07:24:57 +00:00
(e.g. `<html class="dark red">` to give a dark background with red accent):
$base03: #002b36;
$base02: #073642;
$base01: #586e75;
$base00: #657b83;
$base0: #839496;
$base1: #93a1a1;
$base2: #eee8d5;
$base3: #fdf6e3;
$yellow: #b58900;
$orange: #cb4b16;
$red: #dc322f;
2011-03-26 07:24:57 +00:00
$magenta: #d33682;
$violet: #6c71c4;
$blue: #268bd2;
$cyan: #2aa198;
$green: #859900;
2012-08-13 06:50:18 +00:00
@mixin rebase($rebase03,$rebase02,$rebase01,$rebase00,$rebase0,$rebase1,$rebase2,$rebase3)
2011-03-26 07:24:57 +00:00
{
background-color:$rebase03;
color:$rebase0;
* { color:$rebase0; }
h1,h2,h3,h4,h5,h6 { color:$rebase1; border-color: $rebase0; }
a, a:active, a:visited { color: $rebase1; }
}
@mixin accentize($accent) {
a, a:active, a:visited, code.url { color: $accent; }
h1,h2,h3,h4,h5,h6 {color:$accent}
}
/* light is default mode, so pair with general html definition */
html, .light { @include rebase($base3,$base2,$base1,$base0,$base00,$base01,$base02,$base03)}
.dark { @include rebase($base03,$base02,$base01,$base00,$base0,$base1,$base2,$base3)}
html * {
color-profile: sRGB;
rendering-intent: auto;
}
2011-04-05 03:59:10 +00:00
See also [the full css stylesheet for this site](https://github.com/altercation/ethanschoonover.com/blob/master/resources/css/style.css).
2011-03-26 07:24:57 +00:00
Installation
------------
2012-08-13 06:50:18 +00:00
Installation instructions for each version of the colorscheme are included in
the subdirectory README files. Note that for Vim (and possibly for Mutt) you
may want to clone the specific repository (for instance if you are using
2011-03-26 07:24:57 +00:00
Pathogen). See the links at the top of this file.
Font Samples
------------
2012-08-13 06:50:18 +00:00
Solarized has been designed to handle fonts of various weights and retain
2011-03-26 07:24:57 +00:00
readability, from the classic Terminus to the beefy Menlo.
![font samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-fontsamples-light.png)
![font samples - dark](https://github.com/altercation/solarized/raw/master/img/solarized-fontsamples-dark.png)
Clockwise from upper left: Menlo, Letter Gothic, Terminus, Andale Mono.
2012-08-13 06:50:18 +00:00
Preview all code samples in specific font faces by selecting a link from this
list:
2011-04-05 17:07:55 +00:00
* [DejaVu Sans 18](http://ethanschoonover.com/solarized/img/dejavusans18/)
* [DejaVu Sans 14](http://ethanschoonover.com/solarized/img/dejavusans14/)
* [Letter Gothic 18](http://ethanschoonover.com/solarized/img/lettergothic18/)
* [Letter Gothic 14](http://ethanschoonover.com/solarized/img/lettergothic14/)
2011-04-05 17:07:55 +00:00
* [Andale Mono 14](http://ethanschoonover.com/solarized/img/andalemono14/)
* [Monaco 14](http://ethanschoonover.com/solarized/img/monaco14/)
* [Skyhook Mono 14](http://ethanschoonover.com/solarized/img/skyhookmono14/)
2011-04-05 17:07:55 +00:00
* [Terminus 12](http://ethanschoonover.com/solarized/img/terminus12/)
* [Terminus 20](http://ethanschoonover.com/solarized/img/terminus20/)
2011-03-26 07:24:57 +00:00
Screenshots
-----------
Click to view.
### Mutt
[![mutt dark](https://github.com/altercation/solarized/raw/master/img/screen-mutt-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-mutt-dark.png)
[![mutt light](https://github.com/altercation/solarized/raw/master/img/screen-mutt-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-mutt-light.png)
2011-03-26 07:24:57 +00:00
### C (Vim)
[![c dark](https://github.com/altercation/solarized/raw/master/img/screen-c-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-c-dark.png)
[![c light](https://github.com/altercation/solarized/raw/master/img/screen-c-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-c-light.png)
2011-03-26 07:24:57 +00:00
### Haskell (Vim)
[![haskell dark](https://github.com/altercation/solarized/raw/master/img/screen-haskell-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-haskell-dark.png)
[![haskell light](https://github.com/altercation/solarized/raw/master/img/screen-haskell-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-haskell-light.png)
2011-03-26 07:24:57 +00:00
### HTML (Vim)
[![html dark](https://github.com/altercation/solarized/raw/master/img/screen-html-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-html-dark.png)
[![html light](https://github.com/altercation/solarized/raw/master/img/screen-html-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-html-light.png)
2011-03-26 07:24:57 +00:00
### Java (Vim)
[![java dark](https://github.com/altercation/solarized/raw/master/img/screen-java-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-java-dark.png)
[![java light](https://github.com/altercation/solarized/raw/master/img/screen-java-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-java-light.png)
### Javascript (Vim)
[![javascript dark](https://github.com/altercation/solarized/raw/master/img/screen-javascript-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-javascript-dark.png)
[![javascript light](https://github.com/altercation/solarized/raw/master/img/screen-javascript-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-javascript-light.png)
2011-03-26 07:24:57 +00:00
### Pandoc Markdown (Vim)
These screen shots show Vim running with my own [Pandoc Kit Syntax](http://ethanschoonover.com/pandockit/).
2011-03-26 07:24:57 +00:00
[![pandoc dark](https://github.com/altercation/solarized/raw/master/img/screen-pandoc-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-pandoc-dark.png)
[![pandoc light](https://github.com/altercation/solarized/raw/master/img/screen-pandoc-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-pandoc-light.png)
2011-03-26 07:24:57 +00:00
### Perl (Vim)
[![perl dark](https://github.com/altercation/solarized/raw/master/img/screen-perl-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-perl-dark.png)
[![perl light](https://github.com/altercation/solarized/raw/master/img/screen-perl-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-perl-light.png)
### PHP (Vim)
[![php dark](https://github.com/altercation/solarized/raw/master/img/screen-php-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-php-dark.png)
[![php light](https://github.com/altercation/solarized/raw/master/img/screen-php-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-php-light.png)
2011-03-26 07:24:57 +00:00
### Python (Vim)
[![python dark](https://github.com/altercation/solarized/raw/master/img/screen-python-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-python-dark.png)
[![python light](https://github.com/altercation/solarized/raw/master/img/screen-python-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-python-light.png)
2011-03-26 07:24:57 +00:00
### Ruby (Vim)
[![ruby dark](https://github.com/altercation/solarized/raw/master/img/screen-ruby-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-ruby-dark.png)
[![ruby light](https://github.com/altercation/solarized/raw/master/img/screen-ruby-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-ruby-light.png)
### Shell (Vim)
[![shell dark](https://github.com/altercation/solarized/raw/master/img/screen-shell-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-shell-dark.png)
[![shell light](https://github.com/altercation/solarized/raw/master/img/screen-shell-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-shell-light.png)
2011-03-26 07:24:57 +00:00
### TeX (Vim)
[![tex dark](https://github.com/altercation/solarized/raw/master/img/screen-tex-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-tex-dark.png)
[![tex light](https://github.com/altercation/solarized/raw/master/img/screen-tex-light-th.png)](https://github.com/altercation/solarized/raw/master/img/screen-tex-light.png)
2011-03-26 07:24:57 +00:00
The Values
----------
2012-08-13 06:50:18 +00:00
L\*a\*b values are canonical (White D65, Reference D50), other values are
2011-03-26 07:24:57 +00:00
matched in sRGB space.
2011-03-19 04:44:01 +00:00
2011-03-26 07:24:57 +00:00
SOLARIZED HEX 16/8 TERMCOL XTERM/HEX L*A*B RGB HSB
--------- ------- ---- ------- ----------- ---------- ----------- -----------
base03 #002b36 8/4 brblack 234 #1c1c1c 15 -12 -12 0 43 54 193 100 21
base02 #073642 0/4 black 235 #262626 20 -12 -12 7 54 66 192 90 26
base01 #586e75 10/7 brgreen 240 #585858 45 -07 -07 88 110 117 194 25 46
base00 #657b83 11/7 bryellow 241 #626262 50 -07 -07 101 123 131 195 23 51
base0 #839496 12/6 brblue 244 #808080 60 -06 -03 131 148 150 186 13 59
base1 #93a1a1 14/4 brcyan 245 #8a8a8a 65 -05 -02 147 161 161 180 9 63
base2 #eee8d5 7/7 white 254 #e4e4e4 92 -00 10 238 232 213 44 11 93
base3 #fdf6e3 15/7 brwhite 230 #ffffd7 97 00 10 253 246 227 44 10 99
yellow #b58900 3/3 yellow 136 #af8700 60 10 65 181 137 0 45 100 71
orange #cb4b16 9/3 brred 166 #d75f00 50 50 55 203 75 22 18 89 80
red #dc322f 1/1 red 160 #d70000 50 65 45 220 50 47 1 79 86
magenta #d33682 5/5 magenta 125 #af005f 50 65 -05 211 54 130 331 74 83
violet #6c71c4 13/5 brmagenta 61 #5f5faf 50 15 -45 108 113 196 237 45 77
blue #268bd2 4/4 blue 33 #0087ff 55 -10 -45 38 139 210 205 82 82
cyan #2aa198 6/6 cyan 37 #00afaf 60 -35 -05 42 161 152 175 74 63
green #859900 2/2 green 64 #5f8700 60 -20 65 133 153 0 68 100 60
Usage & Development
-------------------
2012-08-13 06:50:18 +00:00
If you are considering developing a port for Solarized, please see also the
[developer notes](http://ethanschoonover.com/solarized/DEVELOPERS) for
information about optional repository structure and readme formats.
2012-08-13 06:50:18 +00:00
Solarized flips between light and dark modes. In each mode, four monotones form
the core values (with an optional fifth for emphasized content).
2012-08-28 06:53:31 +00:00
![value samples - dark](https://github.com/altercation/solarized/raw/master/img/solarized-values-dark.png)
2012-08-28 06:53:31 +00:00
![value samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-values-light.png)
2012-08-13 06:50:18 +00:00
Thus in the case of a dark background colorscheme, the normal relationship for
background and body text is `base03:base0` (please note that body text is
**not** `base00`). Note also that in cases where the background and foreground
can be specified as a pair value, text can be highlighted using a combination
of `base02:base1`. The L\*a\*b lightness difference between `base03:base0` and
`base02:base1` is identical by design, resulting in identical readability
against both normal and highlighted backgrounds. An example use case is folded
text in Vim which uses `base02` for the background and `base1` for the
foreground.
2012-08-13 06:50:18 +00:00
The values in this example are simply inverted in the case of a light
background.
[Vim Repository]: https://github.com/altercation/vim-colors-solarized
[Mutt Repository]: https://github.com/altercation/mutt-colors-solarized
[Emacs Repository]: https://github.com/sellout/emacs-color-theme-solarized
[IntelliJ Repository]: https://github.com/jkaving/intellij-colors-solarized
[NetBeans Repository]: https://github.com/fentie/netbeans-colors-solarized
[SeeStyle-Coda-SubEthaEdit Repository]: https://github.com/bobthecow/solarized-seestyle
[TextMate Repository]: https://github.com/deplorableword/textmate-solarized
[TextWrangler-BBEdit Repository]: https://github.com/rcarmo/textwrangler-bbedit-solarized
[Visual Studio Repository]: https://github.com/leddt/visualstudio-colors-solarized
[Xcode 3]: https://github.com/shayne/solarized/tree/master/apple-xcode3-solarized
[Xcode 4]: https://github.com/brianmichel/solarized/tree/master/apple-xcode4-solarized
[me]: http://ethanschoonover.com/colophon
2011-04-16 17:39:56 +00:00
[changelog]: http://ethanschoonover.com/solarized/CHANGELOG
[Vim README]: http://ethanschoonover.com/solarized/vim-colors-solarized