Skip to content

Commit

Permalink
rewrote the themes and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Koen committed Feb 10, 2015
1 parent dc4f11f commit 55142c3
Show file tree
Hide file tree
Showing 5 changed files with 567 additions and 2,333 deletions.
81 changes: 6 additions & 75 deletions README.mkd
View file
Original file line number Diff line number Diff line change
@@ -1,80 +1,11 @@
Solarized Colorscheme for Sublime Text
=============================
# Solarized

See the [Solarized homepage](http://ethanschoonover.com/solarized) for screenshots,
details and colorscheme versions for Vim, Mutt, popular terminal emulators and
other applications.
Solarized is a color scheme created by [Ethan Schoonover](http://ethanschoonover.com/solarized). There are versions for pretty much every editor out there, available through [Github](https://github.com/altercation/solarized).

## Solarized for Sublime Text

Downloads
---------
This theme is created for Sublime Text (2 and 3). The versions of Solarized avaiable in the default installation use incorrect colors, due to being ported from another editor. The versions available in this package however were created especially for Sublime and the syntax grammars available for Sublime.

If you have come across this page via github please visit the main [Solarized homepage](http://ethanschoonover.com/solarized). The original [Solarized repository] has many more themes and a number of [test files].
To install it, use Sublime Package Control following [these instructions](http://wbond.net/sublime_packages/package_control/installation).

[Solarized homepage]: http://ethanschoonover.com/solarized
[Solarized repository]: https://github.com/altercation/solarized
[test files]: https://github.com/altercation/solarized/tree/master/utils/tests


Sublime Text Support
---------

This theme is fully compatible with [Sublime Text][Sublime]!

To install it, ensure that you have installed Sublime Package Control following [these instructions][SublimePackage]

Open the Sublime command palette with `Ctrl + Shift + P`, type / select `Package Control: Install Package`,
then from the package control list, type / select `Solarized Color Scheme (TextMate)`

Note that packages are auto-updating, so as new modifications are made they will automatically be installed.

[Sublime]: http://www.sublimetext.com/dev
[SublimePackage]: http://wbond.net/sublime_packages/package_control/installation


Contribute
---------

The goal is to get as-close-as-possible to the rendering of the same file in Vim. If you would like to help, here's how to get involved.


1. Fork this repo and checkout your own copy.
2. Download the [sample documents](https://github.com/altercation/solarized/tree/master/utils/tests).
3. Checkout this guide to [TextMate theme development](http://manual.macromates.com/en/themes).
4. Check the [issues](https://github.com/deplorableword/textmate-solarized/issues) to see what needs working on.

Contributors
---------
* [deplorableword](https://github.com/deplorableword)
* [fentie](https://github.com/fentie)
* [bmthykm](https://github.com/bmthykm)
* [Zegnat](https://github.com/zegnat)
* [markstory](https://github.com/markstory)
* [rays](https://github.com/rays)
* [joshcarr](https://github.com/joshcarr)
* [thatRD](https://github.com/thatRD)
* [oesmith](https://github.com/oesmith)
* [evanmoran](https://github.com/evanmoran)
* [iristyle](https://github.com/iristyle)
* [braver](https://github.com/braver)

License
-------

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
![](https://raw.githubusercontent.com/braver/Solarized/master/solarized.png)

13 comments on commit 55142c3

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The colors changes here recently, when used with Go, is not desirable and does not seem to match Ethan Schoonover's original intent of Solarized colors:

http://ethanschoonover.com/solarized#screenshots

Specifically the method/function colors are now a horrible screaming RED which is the biggest different so far.

Are there plans to revert? If not, you may want to rename this package from the name Solarized as it may be misleading.

At this time I've had to switch back to the built-in Solarized color theme in SublimeText 3.

@braver
Copy link
Owner

@braver braver commented on 55142c3 Feb 11, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The community involved with this package has discussed this over the years. We realized that:

  • The vim screenshots cover very little language features.
  • They are very inconstent because of limitation in the language grammars available in vim, not because it was designed specifically as such.
  • The limited and inconsistent nature of this documentation make the implementation guesswork.
  • The language grammars in Sublime are very different, making it impossible to match the vim screenshots even if you try very hard.
  • The attempt to match the screenshots resulted in massive files, over 2000 lines each. In contrast the Base16 Solarized has only 550.
  • This package had many bugs because of the size and becausy the screenshots are contradictory about how language features should be colored.
  • The package had become impossible to maintain, and issues many people were facing with the color schemes could not be solved without causing new problems elsewhere. Or without further deviation from the original.

Just so that it's clear: this color scheme has always deviated from the vim screenshots documenting Ethan's design. In various and problematic ways.

The changes in the recent revisions were a rescue mission. As such, there are no intentions to revert. I have considered keeping the old themes around as a "legacy" verions, but keeping them part of the same would just be confusing and we would not be able to maintain them. This being Github, anyone can just go in and grab the old version.

I don't see any reason to rename. It's closer to the original design than the Solarized themes included in Sublime by default: the colors in that one are completely different thant Ethan's. There are quite few popular implementations that don't completely adhere to the "original design". I don't agree any of this would be misleading.

If you have problems with a certain language, please just open an issue. In it's current state I'm certain we'll be able to resolve them quickly. But realise that the original design doesn't document Go, and many of the screenshots are contradictory as to how language features should be colored. If you're asking for specific Go support, we're going to have to make up how that should look.

@eduncan911, and others who were particularly happy about the previous version of this package, you have two options:

  • Download the 0.1.0 release and install that manually.
  • Fork this package at a point before the changes. You can go ahead and publish your fork on package control if you like, or basically do whatever.

For everyone else, I strongly believe this sets this package back on track to being the best Solarized for Sublime and allow us to build on it going forward.

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the detailed feedback. I haven't been part of any "discussions" since the previous colors were easy on my eyes and just never thought about.

I completely understand the need to simplify/refactor.

After a lot of back and forth and tweaks, I've narrowed down the source of my eye sore:

    <dict>
        <key>name</key>
        <string>Keyword</string>
        <key>scope</key>
        <string>keyword</string>
        <key>settings</key>
        <dict>
            <key>foreground</key>
            <string>#dc322f</string>
        </dict>
    </dict>

It looked like this:

screen shot 2015-02-19 at 7 34 58 pm

I've since found a good balance. I took your theme and changed one single color:

    <dict>
        <key>name</key>
        <string>Keyword</string>
        <key>scope</key>
        <string>keyword</string>
        <key>settings</key>
        <dict>
            <key>foreground</key>
            <string>#859900</string>
        </dict>
    </dict>

It looks like this:

screen shot 2015-02-19 at 7 35 45 pm

As you can see in the screenshots, I've painstakingly created my own overall sublime theme for my Debian (linux) + i3 window manager, custom sublime theme (sidebar, tabs, scrollbars, spacing, etc). I largely did it based on the previous version of this package. (I'm happy to share them if anyone is interested.) I tweaked one other color:

<key>lineHighlight</key>
<string>#073642</string>

Now, everything flows nicely...

screen shot 2015-02-19 at 7 37 17 pm

@braver
Copy link
Owner

@braver braver commented on 55142c3 Feb 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is nice! I agree with your color change for keywords and it allowed me to simplify a bit further. I always like it when I get almost twice as many deletions: 24 insertions(+), 46 deletions(-): https://github.com/braver/sublime-settings/commit/90fbf3d4849bd8e1a3ef67e850c06f309f792836
I will test that across some languages and if all goes well it should get published this weekend.

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Sweet...

The one you have for lineHighlight is very close.. but just slightly off the actual Base02 color. I was wondering if you did that on purpose to bring attention to the line; or, if it was actually the wrong color?

I ask because that is the only reason I changed the lineHighlight above was to match the actual Base02 hue of blue from Ethan's original color pallet that is compatible with 16 colors (http://ethanschoonover.com/solarized). But, i wasn't sure if you purposely changed it slightly to bring more attention to that line highlighted.

I made the tweak so it matched my terminal precisely. But more visually, I did it so it matched my Sublime scrollbars, tabs and sidebar, etc . See my last screenshot above where you can see where line 52 is highlighted which flows right into the gutter, which flows right into the sidebar's scrollbar, which flows right into the highlight in the sidebar for "events_for_articles.go" which also flows up into the tabs. I did this to keep the "monochrome/non-standout" nature of Solarized. All the same color: #073642

Just curious... What are most doing about getting the rest of Sublime in Solarized? Sidebar, tabs, menus, gutters, scrollbars, etc. I recently found a theme that looks similar to mine I posted in the screenshots above - but, it used slightly the wrong hues of Solarized (the colors were off just a tad here and there). I like mine better since it actually matched the hues. :)

@braver
Copy link
Owner

@braver braver commented on 55142c3 Feb 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line-height is intentionally just in-between the gutter background and the editor background. This way it also highlights the gutter/line number. There is something to be said for it all having the same color...

I think most Solarized UI themes actually take the colors from the default Solarized theme, which uses incorrect colors. This is because the default themes were ported from Textmate, which has a rendering bug that causes a slight hue shift that screws up the Solarized colors. So, yeah, that's why we made this color scheme. I don't know the first thing about changing the look of Sublime though, always just use the defaults.

@jibsen
Copy link
Contributor

@jibsen jibsen commented on 55142c3 Feb 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I use the Soda Dark theme with Solarized:

sublime_soda_solarized_z

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@braver

The line-height is intentionally just in-between the gutter background and the editor background.
This way it also highlights the gutter/line number. There is something to be said for it all having
the same color...

Cool. I'll switch to the new theme when ready.

I think most Solarized UI themes actually take the colors from the default Solarized theme,
which uses incorrect colors. This is because the default themes were ported from Textmate,
which has a rendering bug that causes a slight hue shift that screws up the Solarized colors.
So, yeah, that's why we made this color scheme.

And that's exactly why I sought after and installed your Solarized package! The colors were the wrong hues.

And that's exactly why I took the time to skin the rest of Sublime!

I don't know the first thing about changing the look of Sublime though, always just use the defaults.

Ah, you've given me the final reason to release my Sublime theme as a Package to compliment this theme you have!

@jibsen
Copy link
Contributor

@jibsen jibsen commented on 55142c3 Feb 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@braver I think you restored the old theme files when you removed the stuff from your own repo form this one again. At least the themes in the 1.3.0 release appear to still have red keywords, haven't checked the other changes.

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jibsen don't think he's commited it yet... these comments/this thread is for the first original refactor.

there are other commits after this one.

@braver
Copy link
Owner

@braver braver commented on 55142c3 Feb 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jibsen, @eduncan911 Yeah sorry guys, totally messed that up. Gotta remember that a Git subtree looks like a Subversion external, but acts completely different 😳

Anyway, I just pushed a new release, hopefully fixing all this. Sorry!

@eduncan911
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@braver nothing to apologize for!

The package upgraded this morning, I switched from my custom one to yours - without any changes!

👍 👍 👍 Thank you!

And you've inspired me to release my "Sublime Theme" in Solarized as well that matches yours.

@braver
Copy link
Owner

@braver braver commented on 55142c3 Feb 22, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesomesauce! 👍

Please sign in to comment.