From 6c033e62e902907bfdf0560f0a321beda19df45f Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Tue, 17 Nov 2015 02:54:53 +0000 Subject: [PATCH] docs copyedit: Whitespace. --- changelog.md | 2 +- highlighters/brackets/README.md | 2 ++ highlighters/cursor/README.md | 2 ++ highlighters/line/README.md | 2 ++ highlighters/main/README.md | 2 ++ highlighters/pattern/README.md | 2 ++ highlighters/root/README.md | 2 ++ tests/README.md | 2 ++ 8 files changed, 15 insertions(+), 1 deletion(-) diff --git a/changelog.md b/changelog.md index 8d8855c..ad0a0f5 100644 --- a/changelog.md +++ b/changelog.md @@ -3,7 +3,7 @@ up to 1933de83be0bbfb41c44d182fe581ad85012b71a -# Changes in version 0.3.1 +# Changes in version 0.3.1 ## Added highlighting of: diff --git a/highlighters/brackets/README.md b/highlighters/brackets/README.md index 9fd4f96..1df11c1 100644 --- a/highlighters/brackets/README.md +++ b/highlighters/brackets/README.md @@ -6,6 +6,7 @@ This is the ***brackets*** highlighter, that highlights brackets, parenthesis an How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] brackets) @@ -13,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 diff --git a/highlighters/cursor/README.md b/highlighters/cursor/README.md index d28ac19..1cd530f 100644 --- a/highlighters/cursor/README.md +++ b/highlighters/cursor/README.md @@ -6,6 +6,7 @@ This is the ***cursor*** highlighter, that highlights the cursor. How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] cursor) @@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- + This highlighter defines the following styles: * `cursor` - the style for the current cursor position diff --git a/highlighters/line/README.md b/highlighters/line/README.md index 2be32a2..3a7956f 100644 --- a/highlighters/line/README.md +++ b/highlighters/line/README.md @@ -6,6 +6,7 @@ This is the ***line*** highlighter, that highlights the whole line. How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] line) @@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- + This highlighter defines the following styles: * `line` - the style for the whole line diff --git a/highlighters/main/README.md b/highlighters/main/README.md index 9e54669..76826aa 100644 --- a/highlighters/main/README.md +++ b/highlighters/main/README.md @@ -11,6 +11,7 @@ This is the ***main*** highlighter, that highlights: How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] main) @@ -20,6 +21,7 @@ This highlighter is active by default. How to tweak it --------------- + This highlighter defines the following styles: * `unknown-token` - unknown tokens / errors diff --git a/highlighters/pattern/README.md b/highlighters/pattern/README.md index 82a7c65..4e820b3 100644 --- a/highlighters/pattern/README.md +++ b/highlighters/pattern/README.md @@ -6,6 +6,7 @@ This is the ***pattern*** highlighter, that highlights user defined patterns. How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] pattern) @@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- + To use this highlighter, associate patterns with styles in the `ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`: # To have commands starting with `rm -rf` in red: diff --git a/highlighters/root/README.md b/highlighters/root/README.md index 53c871b..870f205 100644 --- a/highlighters/root/README.md +++ b/highlighters/root/README.md @@ -6,6 +6,7 @@ This is the ***root*** highlighter, that highlights the whole line if the curren How to activate it ------------------ + To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] root) @@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- + This highlighter defines the following styles: * `root` - the style for the whole line if the current user is root. diff --git a/tests/README.md b/tests/README.md index 7b17914..afdf0c0 100644 --- a/tests/README.md +++ b/tests/README.md @@ -23,6 +23,7 @@ which is automatically cleaned up after the test exits. highlighting test ----------------- + [`test-highlighting.zsh`](tests/test-highlighting.zsh) tests the correctness of the highlighting. Usage: zsh test-highlighting.zsh @@ -36,6 +37,7 @@ which will run all highlighting tests and report results in [TAP](http://testany performance test ---------------- + [`test-perfs.zsh`](tests/test-perfs.zsh) measures the time spent doing the highlighting. Usage: zsh test-perfs.zsh