diff --git a/highlighters/README.md b/highlighters/README.md index 833b840..00eb2bd 100644 --- a/highlighters/README.md +++ b/highlighters/README.md @@ -3,12 +3,12 @@ zsh-syntax-highlighting / highlighters Syntax highlighting is done by pluggable highlighters: -* [***main***](main) - the base highlighter, and the only one active by default. -* [***brackets***](brackets) - matches brackets and parenthesis. -* [***pattern***](pattern) - matches user-defined patterns. -* [***cursor***](cursor) - matches the cursor position. -* [***root***](root) - triggered if the current user is root. -* [***line***](line) - applied to the whole command line +* [`main`](main) - the base highlighter, and the only one active by default. +* [`brackets`](brackets) - matches brackets and parenthesis. +* [`pattern`](pattern) - matches user-defined patterns. +* [`cursor`](cursor) - matches the cursor position. +* [`root`](root) - triggered if the current user is root. +* [`line`](line) - applied to the whole command line 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 ---------------------------------- -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: _zsh_highlight_myhighlighter_highlighter_predicate() { diff --git a/highlighters/brackets/README.md b/highlighters/brackets/README.md index 440e187..d08097e 100644 --- a/highlighters/brackets/README.md +++ b/highlighters/brackets/README.md @@ -1,7 +1,7 @@ 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 diff --git a/highlighters/cursor/README.md b/highlighters/cursor/README.md index 8e00286..35fa8bd 100644 --- a/highlighters/cursor/README.md +++ b/highlighters/cursor/README.md @@ -1,7 +1,7 @@ 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 diff --git a/highlighters/line/README.md b/highlighters/line/README.md index cc942f2..6cdda00 100644 --- a/highlighters/line/README.md +++ b/highlighters/line/README.md @@ -1,7 +1,7 @@ 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 diff --git a/highlighters/main/README.md b/highlighters/main/README.md index 76826aa..b128a7a 100644 --- a/highlighters/main/README.md +++ b/highlighters/main/README.md @@ -1,7 +1,7 @@ zsh-syntax-highlighting / highlighters / main ============================================= -This is the ***main*** highlighter, that highlights: +This is the `main` highlighter, that highlights: * Commands * Options diff --git a/highlighters/pattern/README.md b/highlighters/pattern/README.md index 5f9cac1..8bdf929 100644 --- a/highlighters/pattern/README.md +++ b/highlighters/pattern/README.md @@ -1,7 +1,7 @@ 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 diff --git a/highlighters/root/README.md b/highlighters/root/README.md index 3bfb6cf..d9fb17a 100644 --- a/highlighters/root/README.md +++ b/highlighters/root/README.md @@ -1,7 +1,7 @@ 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