2018-10-20 01:27:49 +08:00
# colorize
With this plugin you can syntax-highlight file contents of over 300 supported languages and other text formats.
2019-04-23 03:06:47 +08:00
Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting
method for a given extension, it will try to find one by looking at the file contents. If no highlight method
is found it will just cat the file normally, without syntax highlighting.
2019-12-21 13:45:39 +08:00
## Setup
2019-12-21 15:07:16 +08:00
To use it, add colorize to the plugins array of your `~/.zshrc` file:
2018-10-20 01:27:49 +08:00
```
plugins=(... colorize)
```
2019-11-16 04:34:24 +08:00
## Configuration
2018-10-20 01:27:49 +08:00
2019-12-21 13:45:39 +08:00
### Requirements
2019-12-21 15:07:16 +08:00
This plugin requires that either of the following tools be installed:
* Chroma: [https://github.com/alecthomas/chroma ](https://github.com/alecthomas/chroma )
* Pygments be installed: [pygments.org ](https://pygments.org/ )
2019-11-16 04:34:24 +08:00
### Colorize tool
2019-12-21 13:45:39 +08:00
2019-11-16 20:10:02 +08:00
Colorize supports `pygmentize` and `chroma` as syntax highlighter. By default colorize uses `pygmentize` unless it's not installed and `chroma` is. This can be overridden by the `ZSH_COLORIZE_TOOL` environment variable:
2019-11-16 04:34:24 +08:00
```
ZSH_COLORIZE_TOOL=chroma
```
### Styles
2019-03-06 14:34:31 +08:00
Pygments offers multiple styles. By default, the `default` style is used, but you can choose another theme by setting the `ZSH_COLORIZE_STYLE` environment variable:
2019-11-16 04:34:24 +08:00
```
ZSH_COLORIZE_STYLE="colorful"
```
2019-03-06 14:34:31 +08:00
2018-10-20 01:27:49 +08:00
## Usage
2019-12-21 15:07:16 +08:00
* `ccat <file> [files]` : colorize the contents of the file (or files, if more than one are provided).
2019-04-23 03:06:47 +08:00
If no arguments are passed it will colorize the standard input or stdin.
* `cless <file> [files]` : colorize the contents of the file (or files, if more than one are provided) and
open less. If no arguments are passed it will colorize the standard input or stdin.
2018-10-20 01:27:49 +08:00
2019-04-23 03:06:47 +08:00
Note that `cless` will behave as less when provided more than one file: you have to navigate files with
the commands `:n` for next and `:p` for previous. The downside is that less options are not supported.
But you can circumvent this by either using the LESS environment variable, or by running `ccat file1 file2|less --opts` .
In the latter form, the file contents will be concatenated and presented by less as a single file.
