From ef4f5ed638e4575484fd901fb166dd51c7af6310 Mon Sep 17 00:00:00 2001 From: Julien Nicoulaud Date: Sun, 12 Jun 2011 23:16:41 +0200 Subject: [PATCH] Fix READMEs --- highlighters/README.md | 8 ++++---- highlighters/brackets/README.md | 1 + highlighters/main/README.md | 1 + tests/README.md | 4 ++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/highlighters/README.md b/highlighters/README.md index bd02395..c67b6a3 100644 --- a/highlighters/README.md +++ b/highlighters/README.md @@ -3,9 +3,9 @@ zsh-syntax-highlighting / highlighters Syntax highlighting is done by pluggable highlighters: -* [***main***](main) - the base highlighter, and the only one active by default. -* [***brackets***](brackets) - matches brackets and parenthesis. -* [***pattern***](pattern) - matches user-defined patterns. +* [***main***](highlighters/main) - the base highlighter, and the only one active by default. +* [***brackets***](highlighters/brackets) - matches brackets and parenthesis. +* [***pattern***](highlighters/pattern) - matches user-defined patterns. How to activate highlighters @@ -26,7 +26,7 @@ How to implement a new highlighter ---------------------------------- To create your own ***myhighlighter*** highlighter: - + * Create your script at **highlighters/*myhighlighter*/*myhighlighter*-highlighter.zsh**. * Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called, for example: diff --git a/highlighters/brackets/README.md b/highlighters/brackets/README.md index 813c9b9..b0a3d30 100644 --- a/highlighters/brackets/README.md +++ b/highlighters/brackets/README.md @@ -14,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- This highlighter defines the following styles: + * `bracket-error` - unmatched brackets * `bracket-level-N` - brackets with nest level N diff --git a/highlighters/main/README.md b/highlighters/main/README.md index a834572..3841ed5 100644 --- a/highlighters/main/README.md +++ b/highlighters/main/README.md @@ -21,6 +21,7 @@ This highlighter is active by default. How to tweak it --------------- This highlighter defines the following styles: + * `unknown-token` - unknown tokens / errors * `reserved-word` - shell reserved words * `alias` - aliases diff --git a/tests/README.md b/tests/README.md index ed3cd85..f8cac48 100644 --- a/tests/README.md +++ b/tests/README.md @@ -8,13 +8,13 @@ The tests expect the highlighter directory to contain a `test-data` directory wi highlighting test ----------------- -[`test-highlighting.zsh`](test-highlighting.zsh) tests the correctness of the highlighting. Usage: +[`test-highlighting.zsh`](tests/test-highlighting.zsh) tests the correctness of the highlighting. Usage: zsh test-highlighting.zsh performance test ---------------- -[`test-perfs.zsh`](test-highlighting.zsh) measures the time spent doing the highlighting. Usage: +[`test-perfs.zsh`](tests/test-perfs.zsh) measures the time spent doing the highlighting. Usage: zsh test-perfs.zsh