diff options
Diffstat (limited to '.config/shell/zsh-fast-syntax-highlighting/README.md')
| -rw-r--r-- | .config/shell/zsh-fast-syntax-highlighting/README.md | 121 |
1 files changed, 65 insertions, 56 deletions
diff --git a/.config/shell/zsh-fast-syntax-highlighting/README.md b/.config/shell/zsh-fast-syntax-highlighting/README.md index 6ba4ee0..7f50905 100644 --- a/.config/shell/zsh-fast-syntax-highlighting/README.md +++ b/.config/shell/zsh-fast-syntax-highlighting/README.md @@ -1,16 +1,10 @@ -[](https://www.paypal.me/ZdharmaInitiative) -[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D54B3S7C6HGME) -[](https://www.patreon.com/psprint) -<br/>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) +# Fast Syntax Highlighting (F-Sy-H) [![Gitter][gitter-image]][gitter-link] Feature rich syntax highlighting for Zsh. <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/highlight-much.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/highlight-much.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -22,22 +16,20 @@ Feature rich syntax highlighting for Zsh. - [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) + +- [License](https://github.com/zdharma-continuum/fast-syntax-highlighting/blob/master/LICENSE) +- [Changelog](https://github.com/zdharma-continuum/fast-syntax-highlighting/blob/master/CHANGELOG.md) +- [Theme Guide](https://github.com/zdharma-continuum/fast-syntax-highlighting/blob/master/THEME_GUIDE.md) +- [Chroma Guide](https://github.com/zdharma-continuum/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) +- 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 @@ -46,20 +38,35 @@ Feature rich syntax highlighting for Zsh. Clone the Repository. ```zsh -git clone https://github.com/zdharma/fast-syntax-highlighting ~/path/to/fsh +git clone https://github.com/zdharma-continuum/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 +### Zinit Add the following to your `zshrc` file. ```zsh -zplugin light zdharma/fast-syntax-highlighting +zinit light zdharma-continuum/fast-syntax-highlighting +``` + +Here's an example of how to load the plugin together with a few other popular ones with the use of +[Turbo](https://zdharma-continuum.org/zinit/wiki/INTRODUCTION/#turbo_mode_zsh_62_53), i.e.: speeding up the Zsh startup +by loading the plugin right after the first prompt, in background: + +```zsh +zinit wait lucid for \ + atinit"ZINIT[COMPINIT_OPTS]=-C; zicompinit; zicdreplay" \ + zdharma-continuum/fast-syntax-highlighting \ + blockf \ + zsh-users/zsh-completions \ + atload"!_zsh_autosuggest_start" \ + zsh-users/zsh-autosuggestions ``` ### Antigen @@ -67,26 +74,33 @@ zplugin light zdharma/fast-syntax-highlighting Add the following to your `zshrc` file. ```zsh -antigen bundle zdharma/fast-syntax-highlighting +antigen bundle zdharma-continuum/fast-syntax-highlighting ``` +### Fig + +[Fig](https://fig.io) adds apps, shortcuts, and autocomplete to your existing terminal. + +Install `fast-syntax-highlighting` in just one click. + +<a href="https://fig.io/plugins/other/fast-syntax-highlighting_zdharma-continuum" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a> + + ### Zgen -Add the following to your `.zshrc` file in the same place you're doing -your other `zgen load` calls in. +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 +```zsh +zgen load zdharma-continuum/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 +```zsh +git clone https://github.com/zdharma-continuum/fast-syntax-highlighting.git \ + ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/fast-syntax-highlighting ``` And add `fast-syntax-highlighting` to your plugin list. @@ -99,7 +113,7 @@ Switch themes via `fast-theme {theme-name}`. <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/theme.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/theme.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -115,7 +129,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/parameter.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/parameter.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -123,7 +137,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/in_string.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/in_string.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -133,7 +147,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/brackets.gif" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/brackets.gif" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -145,7 +159,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/cplx_cond.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/cplx_cond.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -157,18 +171,17 @@ Exact highlighting that recognizes quotings. <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/ideal-string.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/ideal-string.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> </div> - ### here-strings <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/herestring.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/herestring.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -180,7 +193,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/execfd_cmp.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/execfd_cmp.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -190,7 +203,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/for-loop-cmp.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/for-loop-cmp.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -202,7 +215,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper 2 lines) <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/function.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/function.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -214,7 +227,7 @@ Comparing to the project `zsh-users/zsh-syntax-highlighting` (the upper line): <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/eval_cmp.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/eval_cmp.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -226,21 +239,21 @@ Highlighting that is specific for a given command. <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/git_chroma.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/git_chroma.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> </div> -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). +The [chromas](https://github.com/zdharma-continuum/fast-syntax-highlighting/tree/master/%E2%86%92chroma) that are +enabled by default can be found +[here](https://github.com/zdharma-continuum/fast-syntax-highlighting/blob/master/fast-highlight#L166). ### Math-mode highlighting <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/math.gif" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/math.gif" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> @@ -250,13 +263,14 @@ that are enabled by default can be found <div style="width:100%;background-color:black;border:3px solid black;border-radius:6px;margin:5px 0;padding:2px 5px"> <img - src="https://raw.githubusercontent.com/zdharma/fast-syntax-highlighting/master/images/zcalc.png" + src="https://raw.githubusercontent.com/zdharma-continuum/fast-syntax-highlighting/master/images/zcalc.png" alt="image could not be loaded" style="color:red;background-color:black;font-weight:bold" /> </div> # Performance + Performance differences can be observed in this Asciinema recording, where a `10 kB` function is being edited. <div style="width:100%;background-color:#121314;border:3px solid #121314;border-radius:6px;margin:5px 0;padding:2px 5px"> @@ -265,10 +279,5 @@ Performance differences can be observed in this Asciinema recording, where a `10 </a> </div> -## 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 [](https://kiwiirc.com/client/chat.freenode.net:+6697/#zplugin) +[gitter-image]: https://badges.gitter.im/zdharma-continuum/community.svg +[gitter-link]: https://gitter.im/zdharma-continuum/community |