From 7db849dbd946231f70754dd0dc79b23ef984f702 Mon Sep 17 00:00:00 2001 From: Blista Kanjo Date: Thu, 22 Feb 2024 23:05:58 -0500 Subject: kj-gitbot: .config/shell/zsh-fast-syntax-highlighting/README.md --- .../shell/zsh-fast-syntax-highlighting/README.md | 274 +++++++++++++++++++++ 1 file changed, 274 insertions(+) create mode 100644 .config/shell/zsh-fast-syntax-highlighting/README.md (limited to '.config/shell') diff --git a/.config/shell/zsh-fast-syntax-highlighting/README.md b/.config/shell/zsh-fast-syntax-highlighting/README.md new file mode 100644 index 0000000..6ba4ee0 --- /dev/null +++ b/.config/shell/zsh-fast-syntax-highlighting/README.md @@ -0,0 +1,274 @@ +[![paypal](https://img.shields.io/badge/-Donate-yellow.svg?longCache=true&style=for-the-badge)](https://www.paypal.me/ZdharmaInitiative) +[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D54B3S7C6HGME) +[![patreon](https://img.shields.io/badge/-Patreon-orange.svg?longCache=true&style=for-the-badge)](https://www.patreon.com/psprint) +
New: You can request a feature when donating, even fancy or advanced ones get implemented this way. [There are +reports](DONATIONS.md) about what is being done with the money received. + +# Fast Syntax Highlighting (F-Sy-H) + +Feature rich syntax highlighting for Zsh. + +
+ image could not be loaded +
+ +### Table of Contents + +- [News](#news) +- [Installation](#installation) +- [Features](#features) +- [Performance](#performance) +- [IRC Channel](#irc-channel) + +### Other Contents +- [License](https://github.com/zdharma/fast-syntax-highlighting/blob/master/LICENSE) +- [Changelog](https://github.com/zdharma/fast-syntax-highlighting/blob/master/CHANGELOG.md) +- [Theme Guide](https://github.com/zdharma/fast-syntax-highlighting/blob/master/THEME_GUIDE.md) +- [Chroma Guide](https://github.com/zdharma/fast-syntax-highlighting/blob/master/CHROMA_GUIDE.adoc) + +# News + +* 15-06-2019 + - A new architecture for defining the highlighting for **specific commands**: it now + uses **abstract definitions** instead of **top-down, regular code**. The first effect + is the highlighting for the `git` command it is now **maximally faithful**, it + follows the `git` command almost completely. + [Screencast](https://asciinema.org/a/253411) + +# Installation + +### Manual + +Clone the Repository. + +```zsh +git clone https://github.com/zdharma/fast-syntax-highlighting ~/path/to/fsh +``` + +And add the following to your `zshrc` file. +```zsh +source ~/path/to/fsh/fast-syntax-highlighting.plugin.zsh +``` + +### Zplugin + +Add the following to your `zshrc` file. + +```zsh +zplugin light zdharma/fast-syntax-highlighting +``` + +### Antigen + +Add the following to your `zshrc` file. + +```zsh +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 \ + ~ZSH_CUSTOM/plugins/fast-syntax-highlighting +``` + +And add `fast-syntax-highlighting` to your plugin list. + +# Features + +### Themes + +Switch themes via `fast-theme {theme-name}`. + +
+ image could not be loaded +
+ +Run `fast-theme -t {theme-name}` option to obtain the snippet above. + +Run `fast-theme -l` to list available themes. + +### Variables + +Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): + +
+ image could not be loaded +
+ +
+ image could not be loaded +
+ +### Brackets + +
+ image could not be loaded +
+ +### Conditions + +Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): + +
+ image could not be loaded +
+ +### Strings + +Exact highlighting that recognizes quotings. + +
+ image could not be loaded +
+ + +### here-strings + +
+ image could not be loaded +
+ +### `exec` descriptor-variables + +Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): + +
+ image could not be loaded +
+ +### for-loops and alternate syntax (brace `{`/`}` blocks) + +
+ image could not be loaded +
+ +### Function definitions + +Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper 2 lines): + +
+ image could not be loaded +
+ +### Recursive `eval` and `$( )` highlighting + +Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): + +
+ image could not be loaded +
+ +### Chroma functions + +Highlighting that is specific for a given command. + +
+ image could not be loaded +
+ +The [chromas](https://github.com/zdharma/fast-syntax-highlighting/tree/master/chroma) +that are enabled by default can be found +[here](https://github.com/zdharma/fast-syntax-highlighting/blob/master/fast-highlight#L166). + +### Math-mode highlighting + +
+ image could not be loaded +
+ +### Zcalc highlighting + +
+ image could not be loaded +
+ +# Performance +Performance differences can be observed in this Asciinema recording, where a `10 kB` function is being edited. + +
+ + asciicast + +
+ +## IRC Channel + +Channel `#zplugin@freenode` is a support place for all author's projects. Connect to: +[chat.freenode.net:6697](ircs://chat.freenode.net:6697/%23zplugin) (SSL) or [chat.freenode.net:6667](irc://chat.freenode.net:6667/%23zplugin) + and join #zplugin. + +Following is a quick access via Webchat [![IRC](https://kiwiirc.com/buttons/chat.freenode.net/zplugin.png)](https://kiwiirc.com/client/chat.freenode.net:+6697/#zplugin) -- cgit v1.2.3