diff options
Diffstat (limited to 'plugins/colorize/README.md')
| -rw-r--r-- | plugins/colorize/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md new file mode 100644 index 000000000..c006071f9 --- /dev/null +++ b/plugins/colorize/README.md @@ -0,0 +1,18 @@ +# colorize + +With this plugin you can syntax-highlight file contents of over 300 supported languages and other text formats. + +To use it, add colorize to the plugins array of your zshrc file: +``` +plugins=(... colorize) +``` + +## Usage + +* `ccat <file> [files]`: colorize the contents of the file (or files, if more than one are provided). If no arguments are passed it will colorize the standard input or stdin. + +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. + +## Requirements + +You have to install Pygments first: [pygments.org](http://pygments.org/download/) |