zdharma-continuum.fast-syntax-highlighting/README.md

Fast Syntax Highlighting

Feature rich syntax highlighting for Zsh.

Table of Contents

• Installation
• Features
• Performance

Other Contents

• License
• Changelog
• Theme Guide
• Chroma Guide

Installation

Manual

Clone the Repository.

git clone https://github.com/zdharma/fast-syntax-highlighting ~/path/to/fsh

And add the following to your zshrc file.

source ~/path/to/fsh/fast-syntax-highlighting.plugin.zsh

Zplugin (Recommended)

Add the following to your zshrc file.

zplugin light zdharma/fast-syntax-highlighting

Antigen

Add the following to your zshrc file.

antigen bundle zdharma/fast-syntax-highlighting

Zgen

Add the following to your .zshrc file in the same place you're doing your other zgen load calls in.

zgen load zdharma/fast-syntax-highlighting

Oh-My-Zsh

Clone the Repository.

git clone https://github.com/zdharma/fast-syntax-highlighting.git \
  ~/.oh-my-zsh/custom/plugins/fast-syntax-highlighting

And add fast-syntax-highlighting to your plugin list.

Features

Themes

Switch themes via fast-theme {theme-name}.

Run fast-theme -t {theme-name} option to obtain the snippet above.

Run fast-theme -l to list available themes.

Variables

Brackets

Conditions

Strings

here-strings

exec descriptor-variables

for-loops and alternate syntax (brace {/} blocks)

Function definitions

Recursive eval and $( ) highlighting

Chroma functions

Highlighting that is specific for a given command.

The chromas that are enabled by default can be found here.

Math-mode highlighting

Zcalc highlighting

Performance

Performance differences can be observed in this Asciinema recording, where a 10 kB function is being edited.