diff options
| author | Aaron N. Brock <aaron@functionize.com> | 2019-11-15 15:34:24 -0500 |
|---|---|---|
| committer | Aaron N. Brock <aaron@functionize.com> | 2019-11-15 15:34:24 -0500 |
| commit | 8aa070db0e1f8a5752f0e45834b7093b9b72860f (patch) | |
| tree | 89f61f36dd4b05c7f7fc3816674a484176b1e737 /plugins/colorize | |
| parent | 66e2284a08f86e5dcf661e3cf220483e1fb1f530 (diff) | |
| download | zsh-8aa070db0e1f8a5752f0e45834b7093b9b72860f.tar.gz zsh-8aa070db0e1f8a5752f0e45834b7093b9b72860f.tar.bz2 zsh-8aa070db0e1f8a5752f0e45834b7093b9b72860f.zip | |
Update README.md
Diffstat (limited to 'plugins/colorize')
| -rw-r--r-- | plugins/colorize/README.md | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md index d1f878e62..b6e27fd27 100644 --- a/plugins/colorize/README.md +++ b/plugins/colorize/README.md @@ -10,12 +10,23 @@ To use it, add colorize to the plugins array of your zshrc file: ``` plugins=(... colorize) ``` +## Configuration -## Styles +### Colorize tool + +Colorize supports using either the `pygmentize` tool or the `chroma` tool. By default colorize uses `pygmentize` unless it's not installed & `chroma` is installed. However, you can override this with the `ZSH_COLORIZE_TOOL` environment variable: + +``` +ZSH_COLORIZE_TOOL=chroma +``` + +### Styles 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: -`ZSH_COLORIZE_STYLE="colorful"` +``` +ZSH_COLORIZE_STYLE="colorful" +``` ## Usage @@ -32,4 +43,6 @@ In the latter form, the file contents will be concatenated and presented by less ## Requirements -You have to install Pygments first: [pygments.org](http://pygments.org/download/) +You have to either install Pygments: [pygments.org](http://pygments.org/download/) + +Or install chroma: [https://github.com/alecthomas/chroma](https://github.com/alecthomas/chroma)
\ No newline at end of file |