public/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2025-06-05 12:36:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs copyedit: Restyle bold-italic to fixed-width.

Browse Source
This commit is contained in:
Daniel Shahaf 2015-11-17 03:00:50 +00:00
parent 91e4a576fb
commit 8ea392e361
7 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
highlighters/README.md
View File

@ -3,12 +3,12 @@ zsh-syntax-highlighting / highlighters
Syntax highlighting is done by pluggable highlighters: Syntax highlighting is done by pluggable highlighters:
* [***main***](main) - the base highlighter, and the only one active by default. * [`main`](main) - the base highlighter, and the only one active by default.
* [***brackets***](brackets) - matches brackets and parenthesis. * [`brackets`](brackets) - matches brackets and parenthesis.
* [***pattern***](pattern) - matches user-defined patterns. * [`pattern`](pattern) - matches user-defined patterns.
* [***cursor***](cursor) - matches the cursor position. * [`cursor`](cursor) - matches the cursor position.
* [***root***](root) - triggered if the current user is root. * [`root`](root) - triggered if the current user is root.
* [***line***](line) - applied to the whole command line * [`line`](line) - applied to the whole command line
How to activate highlighters How to activate highlighters
@ -28,9 +28,9 @@ Highlighters look up styles from the `ZSH_HIGHLIGHT_STYLES` array. Navigate into
How to implement a new highlighter How to implement a new highlighter
---------------------------------- ----------------------------------
To create your own ***myhighlighter*** highlighter: To create your own `myhighlighter` highlighter:
* Create your script at **highlighters/*myhighlighter*/*myhighlighter*-highlighter.zsh**. * Create your script at `highlighters/${myhighlighter}/${myhighlighter}-highlighter.zsh`.
* Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called and non-zero otherwise, for example: * Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called and non-zero otherwise, for example:
_zsh_highlight_myhighlighter_highlighter_predicate() { _zsh_highlight_myhighlighter_highlighter_predicate() {

2
highlighters/brackets/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / brackets zsh-syntax-highlighting / highlighters / brackets
================================================= =================================================
This is the ***brackets*** highlighter, that highlights brackets, parenthesis and matches them. This is the `brackets` highlighter, that highlights brackets, parenthesis and matches them.
How to activate it How to activate it

2
highlighters/cursor/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / cursor zsh-syntax-highlighting / highlighters / cursor
================================================= =================================================
This is the ***cursor*** highlighter, that highlights the cursor. This is the `cursor` highlighter, that highlights the cursor.
How to activate it How to activate it

2
highlighters/line/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / line zsh-syntax-highlighting / highlighters / line
================================================= =================================================
This is the ***line*** highlighter, that highlights the whole line. This is the `line` highlighter, that highlights the whole line.
How to activate it How to activate it

2
highlighters/main/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / main zsh-syntax-highlighting / highlighters / main
============================================= =============================================
This is the ***main*** highlighter, that highlights: This is the `main` highlighter, that highlights:
* Commands * Commands
* Options * Options

2
highlighters/pattern/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / pattern zsh-syntax-highlighting / highlighters / pattern
================================================ ================================================
This is the ***pattern*** highlighter, that highlights user defined patterns. This is the `pattern` highlighter, that highlights user defined patterns.
How to activate it How to activate it

2
highlighters/root/README.md
View File

@ -1,7 +1,7 @@
zsh-syntax-highlighting / highlighters / root zsh-syntax-highlighting / highlighters / root
================================================= =================================================
This is the ***root*** highlighter, that highlights the whole line if the current user is root. This is the `root` highlighter, that highlights the whole line if the current user is root.
How to activate it How to activate it