2016-07-28 22:52:31 +03:00
|
|
|
# Colors
|
|
|
|
|
|
|
|
This help page aims to cover two aspects of micro's syntax highlighting engine:
|
|
|
|
|
|
|
|
- How to create colorschemes and use them
|
|
|
|
- How to create syntax files to add to the list of languages micro can highlight
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
|
2017-03-27 18:11:51 +03:00
|
|
|
## Colorschemes
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
Micro comes with a number of colorschemes by default. Here is the list:
|
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
### 256 color
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
These should work and look nice in most terminals. I recommend these
|
|
|
|
themes the most.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
* `monokai`: this is the monokai colorscheme; you may recognize it as Sublime
|
|
|
|
Text's default colorscheme. It requires true color to look perfect, but the
|
|
|
|
256 color approximation looks very good as well. It's also the default
|
|
|
|
colorscheme.
|
|
|
|
* `zenburn`
|
2018-01-08 05:02:24 +03:00
|
|
|
* `gruvbox`
|
2018-01-03 06:46:24 +03:00
|
|
|
* `darcula`
|
|
|
|
* `twilight`
|
2018-01-08 05:02:24 +03:00
|
|
|
* `railscast`
|
2018-01-03 06:46:24 +03:00
|
|
|
* `bubblegum`: a light colorscheme
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2018-01-08 05:02:24 +03:00
|
|
|
### 16 color
|
|
|
|
|
|
|
|
These may vary widely based on the 16 colors selected for your terminal.
|
|
|
|
|
|
|
|
* `simple`: this is the simplest colorscheme. It uses 16 colors which are set by
|
|
|
|
your terminal
|
|
|
|
* `solarized`: You should have the solarized color palette in your terminal to use this colorscheme properly.
|
|
|
|
* `cmc-16`
|
|
|
|
* `cmc-paper`: cmc-16, but on a white background. (Actually light grey
|
|
|
|
on most ANSI (16-color) terminals)
|
|
|
|
* `geany`: Colorscheme based on geany's default highlighting.
|
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
### True color
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
These require terminals that support true color and require `MICRO_TRUECOLOR=1` (this is an environment variable).
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2018-01-03 06:46:24 +03:00
|
|
|
* `solarized-tc`: this is the solarized colorscheme for true color.
|
|
|
|
* `atom-dark-tc`: this colorscheme is based off of Atom's "dark" colorscheme.
|
|
|
|
* `cmc-tc`: A true colour variant of the cmc theme. It requires true color to
|
|
|
|
look its best. Use cmc-16 if your terminal doesn't support true color.
|
|
|
|
* `gruvbox-tc`: The true color version of the gruvbox colorscheme
|
|
|
|
* `github-tc`: The true color version of the Github colorscheme
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
To enable one of these colorschemes just press CtrlE in micro and type
|
|
|
|
`set colorscheme solarized`. (or whichever one you choose). You can also use
|
|
|
|
`set colorscheme monochrome` if you'd prefer to have just the terminal's default
|
|
|
|
foreground and background colors. Note: This provides no syntax highlighting!
|
2017-03-01 17:30:35 +03:00
|
|
|
|
|
|
|
See `help gimmickcolors` for a list of some true colour themes that are more
|
2017-10-11 16:16:53 +03:00
|
|
|
just for fun than for serious use. (Though feel free if you want!)
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
## Creating a Colorscheme
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Micro's colorschemes are also extremely simple to create. The default ones ca
|
|
|
|
be found
|
2016-07-28 22:52:31 +03:00
|
|
|
[here](https://github.com/zyedidia/micro/tree/master/runtime/colorschemes).
|
|
|
|
|
2017-03-01 17:30:35 +03:00
|
|
|
They are only about 18-30 lines in total.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Basically to create the colorscheme you need to link highlight groups with
|
|
|
|
actual colors. This is done using the `color-link` command.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
For example, to highlight all comments in green, you would use the command:
|
|
|
|
|
|
|
|
```
|
|
|
|
color-link comment "green"
|
|
|
|
```
|
|
|
|
|
|
|
|
Background colors can also be specified with a comma:
|
|
|
|
|
|
|
|
```
|
|
|
|
color-link comment "green,blue"
|
|
|
|
```
|
|
|
|
|
|
|
|
This will give the comments a blue background.
|
|
|
|
|
|
|
|
If you would like no foreground you can just use a comma with nothing in front:
|
|
|
|
|
|
|
|
```
|
|
|
|
color-link comment ",blue"
|
|
|
|
```
|
|
|
|
|
|
|
|
You can also put bold, or underline in front of the color:
|
|
|
|
|
|
|
|
```
|
|
|
|
color-link comment "bold red"
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
There are three different ways to specify the color.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Color terminals usually have 16 colors that are preset by the user. This means
|
|
|
|
that you cannot depend on those colors always being the same. You can use those
|
|
|
|
colors with the names `black, red, green, yellow, blue, magenta, cyan, white`
|
|
|
|
and the bright variants of each one (brightblack, brightred...).
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Then you can use the terminals 256 colors by using their numbers 1-256 (numbers
|
|
|
|
1-16 will refer to the named colors).
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
If the user's terminal supports true color, then you can also specify colors
|
|
|
|
exactly using their hex codes. If the terminal is not true color but micro is
|
|
|
|
told to use a true color colorscheme it will attempt to map the colors to the
|
|
|
|
available 256 colors.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Generally colorschemes which require true color terminals to look good are
|
|
|
|
marked with a `-tc` suffix and colorschemes which supply a white background are
|
|
|
|
marked with a `-paper` suffix.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
---
|
|
|
|
|
2016-08-12 21:17:28 +03:00
|
|
|
Here is a list of the colorscheme groups that you can use:
|
|
|
|
|
|
|
|
* default (color of the background and foreground for unhighlighted text)
|
|
|
|
* comment
|
|
|
|
* identifier
|
|
|
|
* constant
|
|
|
|
* statement
|
2017-01-20 22:32:34 +03:00
|
|
|
* symbol
|
2016-08-12 21:17:28 +03:00
|
|
|
* preproc
|
|
|
|
* type
|
|
|
|
* special
|
|
|
|
* underlined
|
|
|
|
* error
|
|
|
|
* todo
|
2017-10-11 16:16:53 +03:00
|
|
|
* statusline (Color of the statusline)
|
|
|
|
* tabbar (Color of the tabbar that lists open files)
|
|
|
|
* indent-char (Color of the character which indicates tabs if the option is
|
|
|
|
enabled)
|
2016-08-12 21:17:28 +03:00
|
|
|
* line-number
|
|
|
|
* gutter-error
|
|
|
|
* gutter-warning
|
|
|
|
* cursor-line
|
2016-09-08 00:17:51 +03:00
|
|
|
* current-line-number
|
|
|
|
* color-column
|
2017-03-01 17:30:35 +03:00
|
|
|
* ignore
|
2017-10-11 16:16:53 +03:00
|
|
|
* divider (Color of the divider between vertical splits)
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Colorschemes must be placed in the `~/.config/micro/colorschemes` directory to
|
|
|
|
be used.
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-01 17:30:35 +03:00
|
|
|
---
|
|
|
|
|
|
|
|
In addition to the main colorscheme groups, there are subgroups that you can
|
2017-10-11 16:16:53 +03:00
|
|
|
specify by adding `.subgroup` to the group. If you're creating your own custom
|
|
|
|
syntax files, you can make use of your own subgroups.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
If micro can't match the subgroup, it'll default to the root group, so it's
|
|
|
|
safe and recommended to use subgroups in your custom syntax files.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
For example if `constant.string` is found in your colorscheme, micro will us
|
|
|
|
that for highlighting strings. If it's not found, it will use constant instead.
|
|
|
|
Micro tries to match the largest set of groups it can find in the colorscheme
|
|
|
|
definitions, so if, for examle `constant.bool.true` is found then micro will use
|
|
|
|
that. If `constant.bool.true` is not found but `constant.bool` is found micro
|
|
|
|
will use `constant.bool`. If not, it uses `constant`.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
|
|
|
Here's a list of subgroups used in micro's built-in syntax files.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* comment.bright (Some filetypes have distinctions between types of comments)
|
2017-03-01 17:30:35 +03:00
|
|
|
* constant.bool
|
|
|
|
* constant.bool.true
|
|
|
|
* constant.bool.false
|
|
|
|
* constant.number
|
|
|
|
* constant.specialChar
|
|
|
|
* constant.string
|
|
|
|
* constant.string.url
|
2017-10-11 16:16:53 +03:00
|
|
|
* identifier.class (Also used for functions)
|
2017-03-01 17:30:35 +03:00
|
|
|
* identifier.macro
|
|
|
|
* identifier.var
|
2017-10-11 16:16:53 +03:00
|
|
|
* preproc.shebang (The #! at the beginning of a file that tells the os what
|
|
|
|
script interpreter to use)
|
2017-11-08 08:23:18 +03:00
|
|
|
* symbol.brackets (`{}()[]` and sometimes `<>`)
|
2017-10-11 16:16:53 +03:00
|
|
|
* symbol.operator (Color operator symbols differently)
|
|
|
|
* symbol.tag (For html tags, among other things)
|
|
|
|
* type.keyword (If you want a special highlight for keywords like `private`)
|
2017-03-01 17:30:35 +03:00
|
|
|
|
|
|
|
In the future, plugins may also be able to use color groups for styling.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
|
2017-03-27 18:11:51 +03:00
|
|
|
## Syntax files
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
The syntax files is written in yaml-format and specify how to highlight
|
|
|
|
languages.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Micro's builtin syntax highlighting tries very hard to be sane, sensible and
|
|
|
|
provide ample coverage of the meaningful elements of a language. Micro has
|
2017-11-08 08:23:18 +03:00
|
|
|
syntax files built in for over 100 languages now! However, there may be
|
2017-10-11 16:16:53 +03:00
|
|
|
situations where you find Micro's highlighting to be insufficient or not to your
|
2017-11-08 08:23:18 +03:00
|
|
|
liking. The good news is that you can create your own syntax files, and place them
|
2017-10-11 16:16:53 +03:00
|
|
|
in `~/.config/micro/syntax` and Micro will use those instead.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
### Filetype definition
|
2017-03-27 01:58:08 +03:00
|
|
|
|
|
|
|
You must start the syntax file by declaring the filetype:
|
2016-08-12 21:17:28 +03:00
|
|
|
|
|
|
|
```
|
2017-03-27 01:58:08 +03:00
|
|
|
filetype: go
|
2016-08-12 21:17:28 +03:00
|
|
|
```
|
|
|
|
|
2017-03-27 01:58:08 +03:00
|
|
|
#### Detect definition
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-27 18:11:51 +03:00
|
|
|
Then you must provide information about how to detect the filetype:
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-27 01:58:08 +03:00
|
|
|
```
|
|
|
|
detect:
|
|
|
|
filename: "\\.go$"
|
|
|
|
```
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Micro will match this regex against a given filename to detect the filetype. You
|
|
|
|
may also provide an optional `header` regex that will check the first line of
|
|
|
|
the file. For example:
|
2017-03-27 01:58:08 +03:00
|
|
|
|
|
|
|
```
|
|
|
|
detect:
|
|
|
|
filename: "\\.ya?ml$"
|
|
|
|
header: "%YAML"
|
|
|
|
```
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-27 01:58:08 +03:00
|
|
|
#### Syntax rules
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Next you must provide the syntax highlighting rules. There are two types of
|
|
|
|
rules: patterns and regions. A pattern is matched on a single line and usually a
|
|
|
|
single word as well. A region highlights between two patterns over multiple
|
|
|
|
lines and may have rules of its own inside the region.
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-27 01:58:08 +03:00
|
|
|
Here are some example patterns in Go:
|
2016-08-12 21:17:28 +03:00
|
|
|
|
|
|
|
```
|
2017-03-27 01:58:08 +03:00
|
|
|
rules:
|
|
|
|
- special: "\\b(break|case|continue|default|go|goto|range|return)\\b"
|
|
|
|
- statement: "\\b(else|for|if|switch)\\b"
|
|
|
|
- preproc: "\\b(package|import|const|var|type|struct|func|go|defer|iota)\\b"
|
2016-08-12 21:17:28 +03:00
|
|
|
```
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
The order of patterns does matter as patterns lower in the file will overwrite
|
|
|
|
the ones defined above them.
|
2017-03-27 01:58:08 +03:00
|
|
|
|
|
|
|
And here are some example regions for Go:
|
|
|
|
|
|
|
|
```
|
|
|
|
- constant.string:
|
|
|
|
start: "\""
|
2017-03-28 03:53:08 +03:00
|
|
|
end: "\""
|
2017-03-27 01:58:08 +03:00
|
|
|
rules:
|
|
|
|
- constant.specialChar: "%."
|
|
|
|
- constant.specialChar: "\\\\[abfnrtv'\\\"\\\\]"
|
|
|
|
- constant.specialChar: "\\\\([0-7]{3}|x[A-Fa-f0-9]{2}|u[A-Fa-f0-9]{4}|U[A-Fa-f0-9]{8})"
|
|
|
|
|
|
|
|
- comment:
|
|
|
|
start: "//"
|
|
|
|
end: "$"
|
|
|
|
rules:
|
|
|
|
- todo: "(TODO|XXX|FIXME):?"
|
|
|
|
|
|
|
|
- comment:
|
|
|
|
start: "/\\*"
|
|
|
|
end: "\\*/"
|
|
|
|
rules:
|
|
|
|
- todo: "(TODO|XXX|FIXME):?"
|
|
|
|
```
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
Notice how the regions may contain rules inside of them. Any inner rules that
|
|
|
|
are matched are then skipped when searching for the end of the region. For
|
|
|
|
example, when highlighting `"foo \" bar"`, since `\"` is matched by an inner
|
|
|
|
rule in the region, it is skipped. Likewise for `"foo \\" bar`, since `\\` is
|
|
|
|
matched by an inner rule, it is skipped, and then the `"` is found and the
|
|
|
|
string ends at the correct place.
|
2017-03-27 01:58:08 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
You may also explicitly mark skip regexes if you don't want them to be
|
|
|
|
highlighted. For example:
|
2017-03-28 03:53:08 +03:00
|
|
|
|
|
|
|
```
|
|
|
|
- constant.string:
|
|
|
|
start: "\""
|
|
|
|
end: "\""
|
|
|
|
skip: "\\."
|
|
|
|
rules: []
|
|
|
|
```
|
2017-03-27 01:58:08 +03:00
|
|
|
|
|
|
|
#### Includes
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
You may also include rules from other syntax files as embedded languages. For
|
|
|
|
example, the following is possible for html:
|
2016-08-12 21:17:28 +03:00
|
|
|
|
|
|
|
```
|
2017-03-27 01:58:08 +03:00
|
|
|
- default:
|
|
|
|
start: "<script.*?>"
|
|
|
|
end: "</script.*?>"
|
|
|
|
rules:
|
|
|
|
- include: "javascript"
|
|
|
|
|
|
|
|
- default:
|
|
|
|
start: "<style.*?>"
|
|
|
|
end: "</style.*?>"
|
|
|
|
rules:
|
|
|
|
- include: "css"
|
2016-08-12 21:17:28 +03:00
|
|
|
```
|