From eb3715a56a88f2eb2a7c4de5978840e22b6f125f Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Thu, 26 Nov 2015 17:33:21 +0000 Subject: [PATCH] docs: Followup to the recent docs branch: clean up some internal cross-references. --- README.md | 4 ++-- docs/highlighters.md | 9 +++++---- highlighters/README.md | 9 ++++++++- 3 files changed, 15 insertions(+), 7 deletions(-) mode change 120000 => 100644 highlighters/README.md diff --git a/README.md b/README.md index 464ffb7..ac8beaf 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/highlighters.md b/docs/highlighters.md index 9443011..91b7f26 100644 --- a/docs/highlighters.md +++ b/docs/highlighters.md @@ -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 diff --git a/highlighters/README.md b/highlighters/README.md deleted file mode 120000 index 7b048c0..0000000 --- a/highlighters/README.md +++ /dev/null @@ -1 +0,0 @@ -../docs/highlighters.md \ No newline at end of file diff --git a/highlighters/README.md b/highlighters/README.md new file mode 100644 index 0000000..8490ddf --- /dev/null +++ b/highlighters/README.md @@ -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.