stonewareslord/zsh-syntax-highlighting
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs copyedit: Whitespace.

Browse Source
This commit is contained in:
Daniel Shahaf 2015-11-17 02:54:53 +00:00
parent e60737d320
commit 6c033e62e9
8 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
highlighters/brackets/README.md
View File

@ -6,6 +6,7 @@ This is the ***brackets*** highlighter, that highlights brackets, parenthesis an
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] brackets) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] brackets)
@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
How to tweak it How to tweak it
--------------- ---------------
This highlighter defines the following styles: This highlighter defines the following styles:
* `bracket-error` - unmatched brackets * `bracket-error` - unmatched brackets

2
highlighters/cursor/README.md
View File

@ -6,6 +6,7 @@ This is the ***cursor*** highlighter, that highlights the cursor.
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] cursor) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] cursor)
@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
How to tweak it How to tweak it
--------------- ---------------
This highlighter defines the following styles: This highlighter defines the following styles:
* `cursor` - the style for the current cursor position * `cursor` - the style for the current cursor position

2
highlighters/line/README.md
View File

@ -6,6 +6,7 @@ This is the ***line*** highlighter, that highlights the whole line.
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] line) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] line)
@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
How to tweak it How to tweak it
--------------- ---------------
This highlighter defines the following styles: This highlighter defines the following styles:
* `line` - the style for the whole line * `line` - the style for the whole line

2
highlighters/main/README.md
View File

@ -11,6 +11,7 @@ This is the ***main*** highlighter, that highlights:
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] main) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] main)
@ -20,6 +21,7 @@ This highlighter is active by default.
How to tweak it How to tweak it
--------------- ---------------
This highlighter defines the following styles: This highlighter defines the following styles:
* `unknown-token` - unknown tokens / errors * `unknown-token` - unknown tokens / errors

2
highlighters/pattern/README.md
View File

@ -6,6 +6,7 @@ This is the ***pattern*** highlighter, that highlights user defined patterns.
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] pattern) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] pattern)
@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
How to tweak it How to tweak it
--------------- ---------------
To use this highlighter, associate patterns with styles in the `ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`: 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: # To have commands starting with `rm -rf` in red:

2
highlighters/root/README.md
View File

@ -6,6 +6,7 @@ This is the ***root*** highlighter, that highlights the whole line if the curren
How to activate it How to activate it
------------------ ------------------
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] root) ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] root)
@ -13,6 +14,7 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
How to tweak it How to tweak it
--------------- ---------------
This highlighter defines the following styles: This highlighter defines the following styles:
* `root` - the style for the whole line if the current user is root. * `root` - the style for the whole line if the current user is root.

2
tests/README.md
View File

@ -23,6 +23,7 @@ which is automatically cleaned up after the test exits.
highlighting test highlighting test
----------------- -----------------
[`test-highlighting.zsh`](tests/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 <HIGHLIGHTER NAME> zsh test-highlighting.zsh <HIGHLIGHTER NAME>
@ -36,6 +37,7 @@ which will run all highlighting tests and report results in [TAP](http://testany
performance test performance test
---------------- ----------------
[`test-perfs.zsh`](tests/test-perfs.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 <HIGHLIGHTER NAME> zsh test-perfs.zsh <HIGHLIGHTER NAME>