docs: Enable Syntax Highlighting for Code Snippits

docs/highlighters.md

@@ -24,7 +24,9 @@ How to activate highlighters
 To activate an highlighter, add it to the `ZSH_HIGHLIGHT_HIGHLIGHTERS` array in
 `~/.zshrc`, for example:
 
-    ZSH_HIGHLIGHT_HIGHLIGHTERS=(main brackets pattern cursor)
+```zsh
+ZSH_HIGHLIGHT_HIGHLIGHTERS=(main brackets pattern cursor)
+```
 
 By default, `$ZSH_HIGHLIGHT_HIGHLIGHTERS` is unset and only the `main`
 highlighter is active.
@@ -58,10 +60,12 @@ To create your own `acme` highlighter:
   This function must return 0 when the highlighter needs to be called and
   non-zero otherwise, for example:
 
-        _zsh_highlight_highlighter_acme_predicate() {
-          # Call this highlighter in SVN working copies
-          [[ -d .svn ]]
-        }
+    ```zsh
+    _zsh_highlight_highlighter_acme_predicate() {
+      # Call this highlighter in SVN working copies
+      [[ -d .svn ]]
+    }
+    ```
 
 * Implement the `_zsh_highlight_highlighter_acme_paint` function.
   This function does the actual syntax highlighting, by calling
@@ -71,18 +75,22 @@ To create your own `acme` highlighter:
   `: ${ZSH_HIGHLIGHT_STYLES[key]:=value}`, being sure to prefix
   the key with your highlighter name and a colon. For example:
 
-        : ${ZSH_HIGHLIGHT_STYLES[acme:aurora]:=fg=green}
+    ```zsh
+    : ${ZSH_HIGHLIGHT_STYLES[acme:aurora]:=fg=green}
 
-        _zsh_highlight_highlighter_acme_paint() {
-          # Colorize the whole buffer with the 'aurora' style
-          _zsh_highlight_add_highlight 0 $#BUFFER acme:aurora
-        }
+    _zsh_highlight_highlighter_acme_paint() {
+      # Colorize the whole buffer with the 'aurora' style
+      _zsh_highlight_add_highlight 0 $#BUFFER acme:aurora
+    }
+    ```
 
   If you need to test which options the user has set, test `zsyh_user_options`
   with a sensible default if the option is not present in supported zsh
   versions. For example:
 
-        [[ ${zsyh_user_options[ignoreclosebraces]:-off} == on ]]
+    ```zsh
+    [[ ${zsyh_user_options[ignoreclosebraces]:-off} == on ]]
+    ```
 
   The option name must be all lowercase with no underscores and not an alias.
 
@@ -100,6 +108,8 @@ To create your own `acme` highlighter:
 
 * Activate your highlighter in `~/.zshrc`:
 
-        ZSH_HIGHLIGHT_HIGHLIGHTERS+=(acme)
+    ```zsh
+    ZSH_HIGHLIGHT_HIGHLIGHTERS+=(acme)
+    ```
 
 * [Write tests](../tests/README.md).

docs/highlighters/brackets.md

@@ -16,11 +16,13 @@ This highlighter defines the following styles:
 To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
 for example in `~/.zshrc`:
 
-    # To define styles for nested brackets up to level 4
-    ZSH_HIGHLIGHT_STYLES[bracket-level-1]='fg=blue,bold'
-    ZSH_HIGHLIGHT_STYLES[bracket-level-2]='fg=red,bold'
-    ZSH_HIGHLIGHT_STYLES[bracket-level-3]='fg=yellow,bold'
-    ZSH_HIGHLIGHT_STYLES[bracket-level-4]='fg=magenta,bold'
+```zsh
+# To define styles for nested brackets up to level 4
+ZSH_HIGHLIGHT_STYLES[bracket-level-1]='fg=blue,bold'
+ZSH_HIGHLIGHT_STYLES[bracket-level-2]='fg=red,bold'
+ZSH_HIGHLIGHT_STYLES[bracket-level-3]='fg=yellow,bold'
+ZSH_HIGHLIGHT_STYLES[bracket-level-4]='fg=magenta,bold'
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`

docs/highlighters/cursor.md

@@ -13,7 +13,9 @@ This highlighter defines the following styles:
 To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
 for example in `~/.zshrc`:
 
-    ZSH_HIGHLIGHT_STYLES[cursor]='bg=blue'
+```zsh
+ZSH_HIGHLIGHT_STYLES[cursor]='bg=blue'
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`

docs/highlighters/line.md

@@ -13,7 +13,9 @@ This highlighter defines the following styles:
 To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
 for example in `~/.zshrc`:
 
-    ZSH_HIGHLIGHT_STYLES[line]='bold'
+```zsh
+ZSH_HIGHLIGHT_STYLES[line]='bold'
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`

docs/highlighters/main.md

@@ -65,17 +65,19 @@ This highlighter defines the following styles:
 To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
 for example in `~/.zshrc`:
 
-    # Declare the variable
-    typeset -A ZSH_HIGHLIGHT_STYLES
+```zsh
+# Declare the variable
+typeset -A ZSH_HIGHLIGHT_STYLES
 
-    # To differentiate aliases from other command types
-    ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold'
-    
-    # To have paths colored instead of underlined
-    ZSH_HIGHLIGHT_STYLES[path]='fg=cyan'
-    
-    # To disable highlighting of globbing expressions
-    ZSH_HIGHLIGHT_STYLES[globbing]='none'
+# To differentiate aliases from other command types
+ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold'
+
+# To have paths colored instead of underlined
+ZSH_HIGHLIGHT_STYLES[path]='fg=cyan'
+
+# To disable highlighting of globbing expressions
+ZSH_HIGHLIGHT_STYLES[globbing]='none'
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`
@@ -86,7 +88,9 @@ manual page][zshzle-Character-Highlighting].
 To avoid partial path lookups on a path, add the path to the `X_ZSH_HIGHLIGHT_DIRS_BLACKLIST` array.
 This interface is still experimental.
 
-    X_ZSH_HIGHLIGHT_DIRS_BLACKLIST+=(/mnt/slow_share)
+```zsh
+X_ZSH_HIGHLIGHT_DIRS_BLACKLIST+=(/mnt/slow_share)
+```
 
 ### Useless trivia
 

docs/highlighters/pattern.md

@@ -9,11 +9,13 @@ This is the `pattern` highlighter, that highlights user-defined patterns.
 To use this highlighter, associate patterns with styles in the
 `ZSH_HIGHLIGHT_PATTERNS` associative array, for example in `~/.zshrc`:
 
-    # Declare the variable
-    typeset -A ZSH_HIGHLIGHT_PATTERNS
+```zsh
+# Declare the variable
+typeset -A ZSH_HIGHLIGHT_PATTERNS
 
-    # To have commands starting with `rm -rf` in red:
-    ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red')
+# To have commands starting with `rm -rf` in red:
+ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red')
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`

docs/highlighters/regexp.md

@@ -10,8 +10,10 @@ patterns.
 To use this highlighter, associate regular expressions with styles in the
 `ZSH_HIGHLIGHT_REGEXP` associative array, for example in `~/.zshrc`:
 
-    typeset -A ZSH_HIGHLIGHT_PATTERNS
-    ZSH_HIGHLIGHT_REGEXP+=('\bsudo\b' fg=123,bold)
+```zsh
+typeset -A ZSH_HIGHLIGHT_PATTERNS
+ZSH_HIGHLIGHT_REGEXP+=('\bsudo\b' fg=123,bold)
+```
 
 This will highlight "sudo" only as a complete word, i.e., "sudo cmd", but not
 "sudoedit"

docs/highlighters/root.md

@@ -14,7 +14,9 @@ This highlighter defines the following styles:
 To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
 for example in `~/.zshrc`:
 
-    ZSH_HIGHLIGHT_STYLES[root]='bg=red'
+```zsh
+ZSH_HIGHLIGHT_STYLES[root]='bg=red'
+```
 
 The syntax for values is the same as the syntax of "types of highlighting" of
 the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`