runtime/help/colors.md

   1 # Colors
   2
   3 This help page aims to cover two aspects of micro's syntax highlighting engine:
   4
   5 - How to create colorschemes and use them
   6 - How to create syntax files to add to the list of languages micro can highlight
   7
   8 ### Colorschemes
   9
  10 Micro comes with a number of colorschemes by default. Here is the list:
  11
  12 * default: this is the simplest colorscheme. It uses 16 colors which are
  13   set by your terminal
  14
  15 * solarized: this is the solarized colorscheme.
  16   You should have the solarized color palette in your terminal to use it.
  17
  18 * solarized-tc: this is the solarized colorscheme for true color, just
  19   make sure your terminal supports true color before using it and that the
  20   MICRO_TRUECOLOR environment variable is set to 1 before starting micro.
  21
  22 * monokai: this is the monokai colorscheme and is micro's default colorscheme
  23   (as well as sublime text's).  It requires true color to
  24   look perfect, but the 256 color approximation looks very good as well.
  25
  26 * atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme.
  27   It requires true color to look good.
  28
  29 To enable one of these colorschemes just run the command `set colorscheme solarized`.
  30 (or whichever one you choose).
  31
  32 ---
  33
  34 Micro's colorschemes are also extremely simple to create. The default ones can be found
  35 [here](https://github.com/zyedidia/micro/tree/master/runtime/colorschemes).
  36
  37 They are only about 18 lines in total.
  38
  39 Basically to create the colorscheme you need to link highlight groups with actual colors.
  40 This is done using the `color-link` command.
  41
  42 For example, to highlight all comments in green, you would use the command:
  43
  44 ```
  45 color-link comment "green"
  46 ```
  47
  48 Background colors can also be specified with a comma:
  49
  50 ```
  51 color-link comment "green,blue"
  52 ```
  53
  54 This will give the comments a blue background.
  55
  56 If you would like no foreground you can just use a comma with nothing in front:
  57
  58 ```
  59 color-link comment ",blue"
  60 ```
  61
  62 You can also put bold, or underline in front of the color:
  63
  64 ```
  65 color-link comment "bold red"
  66 ```
  67
  68 ---
  69
  70 There are three different ways to specify the color.
  71
  72 Color terminals usually have 16 colors that are preset by the user. This means that
  73 you cannot depend on those colors always being the same. You can use those colors with
  74 the names `black, red, green, yellow, blue, magenta, cyan, white` and the bright variants
  75 of each one (brightblack, brightred...).
  76
  77 Then you can use the terminals 256 colors by using their numbers 1-256 (numbers 1-16 will
  78 refer to the named colors).
  79
  80 If the user's terminal supports true color, then you can also specify colors exactly using
  81 their hex codes. If the terminal is not true color but micro is told to use a true color colorscheme
  82 it will attempt to map the colors to the available 256 colors.
  83
  84 Generally colorschemes which require true color terminals to look good are marked with a `-tc` suffix.
  85
  86 ---
  87
  88 Here is a list of the colorscheme groups that you can use:
  89
  90 * default (color of the background and foreground for unhighlighted text)
  91 * comment
  92 * identifier
  93 * constant
  94 * statement
  95 * preproc
  96 * type
  97 * special
  98 * underlined
  99 * error
 100 * todo
 101 * statusline (color of the statusline)
 102 * indent-char (color of the character which indicates tabs if the option is enabled)
 103 * line-number
 104 * gutter-error
 105 * gutter-warning
 106 * cursor-line
 107
 108 Colorschemes can be placed in the `~/.config/micro/colorschemes` directory to be used.
 109
 110 ### Syntax files
 111
 112 The syntax files specify how to highlight certain languages.
 113
 114 The first statement in a syntax file will probably the syntax statement. This tells micro
 115 what language the syntax file is for and how to detect a file in that language.
 116
 117 Essentially, it's just
 118
 119 ```
 120 syntax "Name of language" "\.extension$"
 121 ```
 122
 123 For the extension, micro will just compare that regex to the filename and if it matches then it
 124 will use the syntax rules defined in the remainder of the file.
 125
 126 There is also a possibility to use a header statement which is a regex that micro will compare
 127 with the first line of the file. This is almost only used for shebangs at the top of shell scripts
 128 which don't have any extension (see sh.micro for an example).
 129
 130 ---
 131
 132 The rest of a syntax file is very simple and is essentially a list of regexes specifying how to highlight
 133 different expressions.
 134
 135 It is recommended that when creating a syntax file you use the colorscheme groups (see above) to
 136 highlight different expressions. You may also hard code colors, but that may not look good depending
 137 on what terminal colorscheme the user has installed.
 138
 139 Here is an example to highlight comments (expressions starting with `//`):
 140
 141 ```
 142 color comment "//.*"
 143 ```
 144
 145 This will highlight the regex `//.*` in the color that the user's colorscheme has linked to the comment
 146 group.
 147
 148 Note that this regex only matches the current line. Here is an example for multiline comments (`/* comment */`):
 149
 150 ```
 151 color comment start="/\*" end="\*/"
 152 ```