https://github.com/z-shell/f-sy-h

⚙️ Feature-rich Syntax Highlighting for Zsh
https://github.com/z-shell/f-sy-h

fast-syntax-highlighting feature-rich-syntax-highlighting syntax-highlighting syntax-themes zplugin zsh zsh-plugin

Last synced: about 3 hours ago
JSON representation

⚙️ Feature-rich Syntax Highlighting for Zsh

• Host: GitHub
• URL: https://github.com/z-shell/f-sy-h
• Owner: z-shell
• License: bsd-3-clause
• Created: 2021-11-02T07:59:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T02:04:03.000Z (7 months ago)
• Last Synced: 2024-08-04T04:09:16.822Z (3 months ago)
• Topics: fast-syntax-highlighting, feature-rich-syntax-highlighting, syntax-highlighting, syntax-themes, zplugin, zsh, zsh-plugin
• Language: Shell
• Homepage: https://wiki.zshell.dev/search?q=F-Sy-H
• Size: 1.73 MB
• Stars: 162
• Watchers: 3
• Forks: 23
• Open Issues: 13
• Metadata Files:
  • Readme: docs/README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

    ❮ Zi ❯ - F-Sy-H

Feature-rich Syntax Highlighting for Zsh



  《❔ Ask a Question 》

  《💡 Search Wiki 》

  《💜 Join 》

  《🌐 Localize 》







  





  





  





  





  





  






  

Related



  
License

  
Changelog

  
Theme Guide

  
Chroma Guide



 
Installation


  
Manual


  
Clone the Repository.


git clone https://github.com/z-shell/F-Sy-H ~/path/to/f-sy-h


  
And add the following to your `zshrc` file.


source ~/path/to/f-sy-h/F-Sy-H.plugin.zsh


Zi


  
Add the following to your `zshrc` file.


zi light z-shell/F-Sy-H


 Here's an example of how to load the plugin together with a few other popular ones with the use of

 turbo mode

i.e.: speeding up the Zsh startup by loading the plugin right after the first prompt, in background: 


  
zi wait lucid for \

  atinit"ZI[COMPINIT_OPTS]=-C; zicompinit; zicdreplay" \

     z-shell/F-Sy-H \

  blockf \

     zsh-users/zsh-completions \

  atload"!_zsh_autosuggest_start" \

     zsh-users/zsh-autosuggestions

 


  
Zinit


  
Add the following to your `zshrc` file.


zinit light z-shell/F-Sy-H


  
Antigen


  
Add the following to your `zshrc` file.


antigen bundle z-shell/F-Sy-H --branch=main


  
Zgen


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


  
zgen load z-shell/F-Sy-H . main


  
Oh-My-Zsh


  
Clone the Repository.


git clone https://github.com/z-shell/F-Sy-H.git \

  ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/F-Sy-H


And add F-Sy-H 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


Compared to the project zsh-users/zsh-syntax-highlighting (the

upper line):


  


    

  


  


    

  


  
Brackets


  


    

  


  
Conditions


  


    Comparing to the project zsh-users/zsh-syntax-highlighting (the

    upper line):

  


  


    

  


  
Strings


  
Exact highlighting that recognizes quotes.


  


    

  


  
here-strings








  


exec descriptor-variables


  


    Comparing to the project

    upper line):

  








  


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

  


  


    

  


  
Function definitions


  


    Comparing to the project zsh-users/zsh-syntax-highlighting (the

    upper 2 lines):

  




  


    Recursive eval and $( ) highlighting

  


  


    Comparing to the project zsh-users/zsh-syntax-highlighting (the

    upper line):

  


  


    

  


  
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.

  

  


    

      

    

  

Credits