# MonokaiFree

A beautiful, modern, high quality, Monokai theme for Sublime Text 3.

[![Build Status](https://img.shields.io/travis/gerardroche/sublime-monokai-free/master.svg?style=flat-square)](https://travis-ci.org/gerardroche/sublime-monokai-free) [![Build status](https://img.shields.io/appveyor/ci/gerardroche/sublime-monokai-free/master.svg?style=flat-square)](https://ci.appveyor.com/project/gerardroche/sublime-monokai-free/branch/master) [![Minimum Sublime Version](https://img.shields.io/badge/sublime-%3E%3D%203.0-brightgreen.svg?style=flat-square)](https://sublimetext.com) [![Latest Stable Version](https://img.shields.io/github/tag/gerardroche/sublime-monokai-free.svg?style=flat-square&label=stable)](https://github.com/gerardroche/sublime-monokai-free/tags) [![GitHub stars](https://img.shields.io/github/stars/gerardroche/sublime-monokai-free.svg?style=flat-square)](https://github.com/gerardroche/sublime-monokai-free/stargazers) [![Downloads](https://img.shields.io/packagecontrol/dt/MonokaiFree.svg?style=flat-square)](https://packagecontrol.io/packages/MonokaiFree) [![Author](https://img.shields.io/badge/twitter-gerardroche-blue.svg?style=flat-square)](https://twitter.com/gerardroche)

* Enhanced syntax highlighting for PHP, HTML, CSS, Markdown, JavaScript, Ruby, Python.
* Additional syntax highlighting for LESS, Sass, Laravel Blade, Visual Studio Code.
* Supported plugins: [GitGutter][], [SublimeLinter][], [NeoVintageous][], [PHPUnitKit][].

## Installation

### Package Control installation

The preferred method of installation is [Package Control](https://packagecontrol.io/packages/MonokaiFree).

### Manual installation

Close Sublime Text, then download or clone this repository to a directory named `MonokaiFree` in the Sublime Text Packages directory for your platform:

* Linux: `git clone https://github.com/gerardroche/sublime-monokai-free.git ~/.config/sublime-text-3/Packages/MonokaiFree`
* OSX: `git clone https://github.com/gerardroche/sublime-monokai-free.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/MonokaiFree`
* Windows: `git clone https://github.com/gerardroche/sublime-monokai-free.git %APPDATA%\Sublime/ Text/ 3/Packages/MonokaiFree`

## ACTIVATE

Go to `Menu > Preferences > Color Scheme...` and select MonokaiFree.

## SCREENSHOTS

### CSS

![CSS screenshot](screenshot-css.png)

### HTML

![HTML screenshot](screenshot-html.png)

### PHP

![PHP screenshot](screenshot-php.png)

![PHP screenshot](screenshot-php-extras.png)

### XML

![XML screenshot](screenshot-xml.png)

## CUSTOMISATION

In newer versions of Sublime Text (`>= 3154`) customising your theme is straight forward enough.

Create a color scheme override in your Sublime Text User directory (find the User directory via `Menu > Preferences > Browse Packages...`).

Name the override file: `MonokaiFree.sublime-color-scheme`.

You can configure overrides for anything you like; here's an example configuring a darker background, gutter, comments, and yellowish selections:

```
{
    "globals":
    {
        "background": "#1b1d1e",
        "gutter": "#1b1d1e",
        "gutter_foreground": "#7e8e919d",
        "selection": "#e6db74",
    },

    "rules":
    [
        {
            "scope": "comment, punctuation.definition.comment",
            "foreground": "#7e8e91"
        }
    ]
}
```

## CONTRIBUTING

### Tests

To run the tests install [ColorSchemeUnit][] (a framework for testing Sublime Text color schemes), and run the `ColorSchemeUnit: Test Suite` command via the Command Palette (`Ctrl+Shift+P`).

### The Values

The colors are not set in stone. Please advice of better choices. There are also still two background and one foreground shades yet to be selected.

![Color palette](palette.png)

```text
COLOR TABLE

MONOKAIFREE HEX     RGB         EXAMPLE USAGE
*********** ******* *********** ********************************************
bg0         #272822  39  40  34
bg1         #3e3d32  62  61  50 Rulers, invisibles.
bg2         ??????? ??? ??? ???
bg3         ??????? ??? ??? ???
fg0         #f8f8f2 248 248 242 Text
fg1         #cfcfc2 207 207 194 Text (soft)
fg2         #75715e 117 113  94 Comments, selections, gutter text.
fg3         ??????? ??? ??? ???
yellow      #e6db74 230 219 116 Strings, cursors.
orange      #fd971f 253 151  31 Language identifiers, function parameters.
red         #f92672 249  38 114 Control structures, modifiers, operators.
magenta     #fd5ff0 253  95 240
violet      #ae81ff 174 129 255 Constants, numbers, booleans.
blue        #66d9ef 102 217 239
cyan        #a1efe4 161 239 228
green       #a6e22e 166 226  46 Class names, function names.
```

## LICENSE

Released under the [BSD 3-Clause License](LICENSE).

[ColorSchemeUnit]: https://github.com/gerardroche/sublime-color-scheme-unit
[GitGutter]: https://github.com/jisaacks/GitGutter
[NeoVintageous]: https://github.com/NeoVintageous/NeoVintageous
[PHPUnitKit]: https://github.com/gerardroche/sublime-phpunit
[SublimeLinter]: https://github.com/SublimeLinter/SublimeLinter3