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 Colorschemes can be placed in the `~/.config/micro/colorschemes` directory to be used.
  89
  90 ### Syntax files
  91
  92 The syntax files specify how to highlight certain languages.
  93
  94 In progress...