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-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:
|
|
|
|
|
2016-08-28 20:07:47 +03:00
|
|
|
* simple: this is the simplest colorscheme. It uses 16 colors which are
|
2016-07-28 22:52:31 +03:00
|
|
|
set by your terminal
|
|
|
|
|
2017-03-01 17:30:35 +03:00
|
|
|
* mc: A 16-color theme based on the look and feel of GNU Midnight Commander.
|
|
|
|
This will look great used in conjunction with Midnight Commander.
|
|
|
|
|
|
|
|
* nano: A 16-color theme loosely based on GNU nano's syntax highlighting.
|
|
|
|
|
2016-10-11 16:13:03 +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: The 'zenburn' colorscheme and works well with 256 color terminals
|
2016-08-28 05:00:56 +03:00
|
|
|
|
2017-01-20 22:32:34 +03:00
|
|
|
* solarized: this is the solarized colorscheme.
|
2016-07-28 22:52:31 +03:00
|
|
|
You should have the solarized color palette in your terminal to use it.
|
|
|
|
|
2017-01-20 22:32:34 +03:00
|
|
|
* solarized-tc: this is the solarized colorscheme for true color; just
|
|
|
|
make sure your terminal supports true color before using it and that the
|
2016-07-28 22:52:31 +03:00
|
|
|
MICRO_TRUECOLOR environment variable is set to 1 before starting micro.
|
|
|
|
|
|
|
|
* atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme.
|
|
|
|
It requires true color to look good.
|
|
|
|
|
2017-03-01 17:30:35 +03:00
|
|
|
* cmc-16: A very nice 16-color theme. Written by contributor CaptainMcClellan
|
|
|
|
(Collin Warren.) Licensed under the same license as the rest of the themes.
|
|
|
|
|
|
|
|
* cmc-paper: Basically cmc-16, but on a white background. ( Actually light grey on most
|
|
|
|
ANSI (16-color) terminals.)
|
|
|
|
|
|
|
|
* 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.
|
|
|
|
|
|
|
|
* codeblocks: A colorscheme based on the Code::Blocks IDE's default syntax highlighting.
|
|
|
|
|
|
|
|
* codeblocks-paper: Same as codeblocks, but on a white background. ( Actually light grey. )
|
|
|
|
|
|
|
|
* github-tc: A colorscheme based on Github's syntax highlighting. Requires true color to look its best.
|
|
|
|
|
|
|
|
* paper-tc: A nice minimalist theme with a light background, good for editing documents on.
|
|
|
|
Requires true color to look its best. Not to be confused with `-paper` suffixed themes.
|
|
|
|
|
2017-03-03 19:48:51 +03:00
|
|
|
* geany: Colorscheme based on geany's default highlighting.
|
2017-03-01 17:30:35 +03:00
|
|
|
|
|
|
|
* geany-alt-tc: Based on an alternate theme bundled with geany.
|
|
|
|
|
|
|
|
* flamepoint-tc: A fire inspired, high intensity true color theme written by CaptainMcClellan.
|
|
|
|
As with all the other `-tc` suffixed themes, it looks its best on a
|
|
|
|
|
2016-12-14 18:30:03 +03:00
|
|
|
To enable one of these colorschemes just press CtrlE in micro and type `set colorscheme solarized`.
|
2017-03-01 17:30:35 +03:00
|
|
|
(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!
|
|
|
|
|
|
|
|
See `help gimmickcolors` for a list of some true colour themes that are more
|
|
|
|
just for fun than for serious use. ( Though feel free if you want! )
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
---
|
|
|
|
|
2017-03-01 17:30:35 +03:00
|
|
|
### Creating a Colorscheme
|
|
|
|
|
2016-07-28 22:52:31 +03:00
|
|
|
Micro's colorschemes are also extremely simple to create. The default ones can be found
|
|
|
|
[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
|
|
|
|
|
|
|
Basically to create the colorscheme you need to link highlight groups with actual colors.
|
|
|
|
This is done using the `color-link` command.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
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...).
|
|
|
|
|
|
|
|
Then you can use the terminals 256 colors by using their numbers 1-256 (numbers 1-16 will
|
|
|
|
refer to the named colors).
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
2017-03-01 17:30:35 +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-03-03 19:48:51 +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-03-03 19:48:51 +03:00
|
|
|
* divider ( Color of the divider between vertical splits. )
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-01 17:30:35 +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
|
|
|
|
specify by adding `.subgroup` to the group. If you're creating your own
|
|
|
|
custom syntax files, you can make use of your own subgroups.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
For example if `constant.string` is found in your colorscheme, micro will
|
|
|
|
use 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`.
|
|
|
|
|
|
|
|
Here's a list of subgroups used in micro's built-in syntax files.
|
|
|
|
|
|
|
|
* comment.bright ( Some filetypes have distinctions between types of comments.)
|
|
|
|
* constant.bool
|
|
|
|
* constant.bool.true
|
|
|
|
* constant.bool.false
|
|
|
|
* constant.number
|
|
|
|
* constant.specialChar
|
|
|
|
* constant.string
|
|
|
|
* constant.string.url
|
|
|
|
* identifier.class ( Also used for functions. )
|
|
|
|
* identifier.macro
|
|
|
|
* identifier.var
|
2017-03-03 19:47:03 +03:00
|
|
|
* preproc.shebang ( The #! at the beginning of a file that tells the os what script interpreter to use. )
|
2017-03-01 17:30:35 +03:00
|
|
|
* symbol.brackets ( {}()[] and sometimes <> )
|
|
|
|
* 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` )
|
|
|
|
|
|
|
|
In the future, plugins may also be able to use color groups for styling.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-03-27 18:11:51 +03:00
|
|
|
## Syntax files
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-03-27 18:11:51 +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-03-01 17:30:35 +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
|
|
|
|
syntax files built int for over 100 languages now. However, there may be
|
|
|
|
situations where you find Micro's highlighting to be insufficient or not to
|
|
|
|
your liking. Good news is you can create syntax files (.micro extension), place them in
|
|
|
|
`~/.config/micro/syntax` and Micro will use those instead.
|
|
|
|
|
2017-03-27 18:11:51 +03:00
|
|
|
### Filetype defintion
|
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$"
|
|
|
|
```
|
|
|
|
|
|
|
|
Micro will match this regex against a given filename to detect the filetype. You may also
|
2017-03-27 18:11:51 +03:00
|
|
|
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-03-27 01:58:08 +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-03-27 01:58:08 +03:00
|
|
|
The order of patterns does matter as patterns lower in the file will overwrite the ones defined above them.
|
|
|
|
|
|
|
|
And here are some example regions for Go:
|
|
|
|
|
|
|
|
```
|
|
|
|
- constant.string:
|
|
|
|
start: "\""
|
|
|
|
end: "(?<!\\\\)\""
|
|
|
|
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):?"
|
|
|
|
```
|
|
|
|
|
|
|
|
Notice how the regions may contain rules inside of them.
|
|
|
|
|
|
|
|
Also the regexes for region start and end may contain more complex regexes with lookahead and lookbehind,
|
|
|
|
but this is not supported for pattern regexes.
|
|
|
|
|
|
|
|
#### Includes
|
2016-08-12 21:17:28 +03:00
|
|
|
|
2017-03-27 01:58:08 +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
|
|
|
```
|