docs: Followup to the recent docs branch: clean up some internal cross-references.

This commit is contained in:
Daniel Shahaf 2015-11-26 17:33:21 +00:00
parent 95330c691b
commit eb3715a56a
3 changed files with 15 additions and 7 deletions

View file

@ -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.

View file

@ -27,10 +27,11 @@ 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

View file

@ -1 +0,0 @@
../docs/highlighters.md

8
highlighters/README.md Normal file
View file

@ -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.