docs/style-guide.md
<table> <tr> <th colspan="3" align="center"><h4>Background Colors</h4></th> </tr> <tr> <th>Function</th> <th colspan="2">Colors</th> </tr> <tr> <td>Background Pane</td> <td>Base</td> <td>[!IMPORTANT] Text colors are guidelines, certain cases require deviations from the guidelines below. An example would be
texton colored backgrounds. Legibility always comes first, so please use your own judgement.
</td>
Mantle
</td>
<td>
</td>
Surface 1,
Surface 2
</td>
<td>
</td>
Overlay 1,
Overlay 2
</td>
<td>
</td>
</td>
</td>
Subtext 1
</td>
<td>
</td>
</td>
</td>
</td>
</td>
</td>
</td>
</td>
<strong>20% - 30% Opacity</strong>
</td>
<td>
</td>
</td>
[!NOTE]
These bright colors are not necessarily "brighter" than the normal colors, but rather more bold and saturated.
The ANSI brights, excluding black and white, are automatically generated based on the following formulas:
color.hue + 2</code></pre> </td>
</tr> </table>The color values for black and white are mapped as shown below:
Black (8): <code>Surface 2</code>
White (7): <code>Subtext 0</code>
White (15): <code>Subtext 1</code>
</td>
<td>
Black (0): <code>Subtext 1</code>
Black (8): <code>Subtext 0</code>
White (7): <code>Surface 2</code>
White (15): <code>Surface 1</code>
</td>
<table> <tr> <td> <table> <tr> <th colspan="3" align="center"> <h4>Language Defaults</h4> </th> </tr> <tr> <th>Syntax</th> <th colspan="2">Color</th> </tr> <tr> <td>Keyword</td> <td>Mauve</td> <td>[!IMPORTANT] This is still a work-in-progress. Additionally, it's important to acknowledge that different editors have different capabilities for theming, please use your own judgement in accordance with the main colors defined below.
</td>
</tr>
<tr>
<td>Strings</td>
<td>Green</td>
<td>
</td>
</tr>
<tr>
<td>Symbols, Atoms</td>
<td>Red</td>
<td>
</td>
</tr>
<tr>
<td>
Escape Sequences
Regex
</td>
<td>Pink</td>
<td>
</td>
</tr>
<tr>
<td>Comments</td>
<td>Overlay 2</td>
<td>
</td>
</tr>
<tr>
<td>Constants, Numbers</td>
<td>Peach</td>
<td>
</td>
</tr>
<tr>
<td>Operators</td>
<td>Sky</td>
<td>
</td>
</tr>
<tr>
<td>Braces, Delimiters</td>
<td>Overlay 2</td>
<td>
</td>
</tr>
<tr>
<td>Methods, Functions</td>
<td>Blue</td>
<td>
</td>
</tr>
<tr>
<td>Parameters</td>
<td>Maroon</td>
<td>
</td>
</tr>
<tr>
<td>Builtins</td>
<td>Red</td>
<td>
</td>
</tr>
<tr>
<td>
Classes, Interfaces,
Annotations, Metadata,
Enums, Types
</td>
<td>Yellow</td>
<td>
</td>
</tr>
<tr>
<td>Enum Variants</td>
<td>Teal</td>
<td>
</td>
</tr>
<tr>
<td>
Property
(e.g. JSON keys)
</td>
<td>Blue</td>
<td>
</td>
</tr>
<tr>
<td>
Attributes
(e.g. XML-style attributes)
</td>
<td>Yellow</td>
<td>
</td>
</tr>
<tr>
<td>
Macros
</td>
<td>Rosewater</td>
<td>
</td>
</tr>
</table>
</td>
<td>
<table>
<tr>
<th colspan="3" align="center">
<h4>General</h4>
</th>
</tr>
<tr>
<th>Syntax</th>
<th colspan="2">Color</th>
</tr>
<tr>
<td>Cursor</td>
<td>Rosewater</td>
<td>
</td>
</tr>
<tr>
<td>Cursor Line</td>
<td>
Text
<strong>10% Opacity</strong>
</td>
<td>
</td>
</tr>
<tr>
<td>Line Numbers</td>
<td>Overlay 1</td>
<td>
</td>
</tr>
<tr>
<td>Active Line Number</td>
<td>Lavender</td>
<td>
</td>
</tr>
<tr>
<td>
Normal Links
Followed Links
On Hover Links
</td>
<td>
Blue
Lavender
Sky
</td>
<td>
</td>
</tr>
<tr>
<td>
Search FG
Search BG
Active Search FG
Active Search BG
</td>
<td>
Text
Teal
Text
Red
</td>
<td>
</td>
</tr>
<tr>
<td>Errors</td>
<td>Red</td>
<td>
</td>
</tr>
<tr>
<td>Warnings</td>
<td>Yellow
Peach</td> <td>
</td>
</tr>
<tr>
<td>Information</td>
<td>Teal</td>
<td>
</td>
</tr>
</table>
</td>
(Brackets, Headings, etc.)
</h4>
</th>
</tr>
<tr>
<th>Syntax</th>
<th colspan="2">Color</th>
</tr>
<tr>
<td>Color #1</td>
<td>Red</td>
<td>
</td>
</tr>
<tr>
<td>Color #2</td>
<td>Peach</td>
<td>
</td>
</tr>
<tr>
<td>Color #3</td>
<td>Yellow</td>
<td>
</td>
</tr>
<tr>
<td>Color #4</td>
<td>Green</td>
<td>
</td>
</tr>
<tr>
<td>Color #5</td>
<td>Sapphire</td>
<td>
</td>
</tr>
<tr>
<td>Color #6</td>
<td>Lavender</td>
<td>
</td>
</tr>
</table>
</td>
<td>
<table>
<tr>
<th colspan="3" align="center">
<h4>Rainbow Parameters &
Local Variables</h4> </th> </tr> <tr> <th>Syntax</th> <th colspan="2">Color</th> </tr> <tr> <td>Color #1</td> <td>60% Text/Red Mix</td> <td>
</td>
</tr>
<tr>
<td>Color #2</td>
<td>60% Text/Yellow Mix</td>
<td>
</td>
</tr>
<tr>
<td>Color #3</td>
<td>60% Text/Green Mix</td>
<td>
</td>
</tr>
<tr>
<td>Color #4</td>
<td>60% Text/Teal Mix</td>
<td>
</td>
</tr>
<tr>
<td>Color #5</td>
<td>60% Text/Blue Mix</td>
<td>
</td>
</tr>
<tr>
<td>Color #6</td>
<td>60% Text/Mauve Mix</td>
<td>
</td>
</tr>
</table>
</td>
</td>
</td>
</td>
</td>
Changed Line BG
</td>
<td>
Blue <strong>(10% - 20% Opacity)</strong>
Blue <strong>(15% - 25% Opacity)</strong>
</td>
<td>
</td>
Inserted Line BG
</td>
<td>
Green <strong>(10% - 20% Opacity)</strong>
Green <strong>(15% - 25% Opacity)</strong>
</td>
<td>
</td>
Removed Line BG
</td>
<td>
Red <strong>(10% - 20% Opacity)</strong>
Red <strong>(15% - 25% Opacity)</strong>
</td>
<td>
</td>
</td>
</td>