Skip to content

Commit

Permalink
docs: Tweaks to highlighters.md after recent refactoring branch.
Browse files Browse the repository at this point in the history
Merge remote-tracking branch 'danielsh/docs-highlighters.d-landing-page-v3'

* danielsh/docs-highlighters.d-landing-page-v3:
  docs: Restore (with changes) links removed in f5ca4b8.
  docs: Followup to the recent docs branch: clean up some internal cross-references.
  docs: Clarify tagline summary of 'root' highlighter
  docs: Minor clarification.

Fixes zsh-users/zsh-syntax-highlighting#242.
  • Loading branch information
danielshahaf committed Nov 27, 2015
2 parents 2e5481a + 1f1ad09 commit 952a97d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ How to tweak
------------

Syntax highlighting is done by pluggable highlighter scripts. See the
[`highlighters` directory](./highlighters) for documentation and configuration
settings.
[documentation on highlighters](docs/highlighters.md) for details and
configuration settings.
30 changes: 19 additions & 11 deletions docs/highlighters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,19 @@ zsh-syntax-highlighting / highlighters

Syntax highlighting is done by pluggable highlighters:

* `main` - the base highlighter, and the only one active by default.
* `brackets` - matches brackets and parenthesis.
* `pattern` - matches user-defined patterns.
* `cursor` - matches the cursor position.
* `root` - triggered if the current user is root.
* `line` - applied to the whole command line
* `main` - the base highlighter, and the only one [active by default][1].
* `brackets` - [matches brackets][2] and parenthesis.
* `pattern` - matches [user-defined patterns][3].
* `cursor` - matches [the cursor position][4].
* `root` - highlights the whole command line [if the current user is root][5].
* `line` - applied to [the whole command line][6].

[1]: highlighters/main.md
[2]: highlighters/brackets.md
[3]: highlighters/pattern.md
[4]: highlighters/cursor.md
[5]: highlighters/root.md
[6]: highlighters/line.md


How to activate highlighters
Expand All @@ -27,15 +34,16 @@ How to tweak highlighters
-------------------------

Highlighters look up styles from the `ZSH_HIGHLIGHT_STYLES` associative array.
Navigate into each highlighter directory to see what styles (keys) it defines;
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)`
manual page][zshzle-Character-Highlighting].
Navigate into the [individual highlighters' documentation](highlighters/) to
see what styles (keys) each highlighter defines; 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)` manual
page][zshzle-Character-Highlighting].

[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting

Some highlighters support additional configuration parameters; see each
highlighter's documentation for details.
highlighter's documentation for details and examples.


How to implement a new highlighter
Expand Down
1 change: 0 additions & 1 deletion highlighters/README.md

This file was deleted.

8 changes: 8 additions & 0 deletions highlighters/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
zsh-syntax-highlighting / highlighters
======================================

Navigate into the individual highlighters' documentation to see
what styles (`$ZSH_HIGHLIGHT_STYLES` keys) each highlighter defines.

Refer to the [documentation on highlighters](../docs/highlighters.md) for further
information.

0 comments on commit 952a97d

Please sign in to comment.