From 371f8183d6f98e7db6afc6459cba75ba0dc6b89a Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Thu, 26 Nov 2015 17:15:48 +0000 Subject: [PATCH 1/4] docs: Minor clarification. --- docs/highlighters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/highlighters.md b/docs/highlighters.md index cb13d50..3fabc8c 100644 --- a/docs/highlighters.md +++ b/docs/highlighters.md @@ -35,7 +35,7 @@ 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 From 95330c691bae3c82e7e56ebf122f1bbf28a02de6 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Fri, 27 Nov 2015 03:36:36 +0000 Subject: [PATCH 2/4] docs: Clarify tagline summary of 'root' highlighter --- docs/highlighters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/highlighters.md b/docs/highlighters.md index 3fabc8c..9443011 100644 --- a/docs/highlighters.md +++ b/docs/highlighters.md @@ -7,7 +7,7 @@ Syntax highlighting is done by pluggable highlighters: * `brackets` - matches brackets and parenthesis. * `pattern` - matches user-defined patterns. * `cursor` - matches the cursor position. -* `root` - triggered if the current user is root. +* `root` - highlights the whole command line if the current user is root. * `line` - applied to the whole command line From eb3715a56a88f2eb2a7c4de5978840e22b6f125f Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Thu, 26 Nov 2015 17:33:21 +0000 Subject: [PATCH 3/4] 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. From 1f1ad09e38aa06f72dee0676eb49d9a0f3481fdb Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Thu, 26 Nov 2015 17:39:51 +0000 Subject: [PATCH 4/4] docs: Restore (with changes) links removed in f5ca4b891b69478c98e2f04200aeae7c726fc05b. The preceding commit, which made docs/highlighters.md and highlighters/README.md distinct, allows reverting their removal. --- docs/highlighters.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/highlighters.md b/docs/highlighters.md index 91b7f26..266abe1 100644 --- a/docs/highlighters.md +++ b/docs/highlighters.md @@ -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` - highlights the whole command line 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