610b2529d2213a70e3d1153a9baf046c22f298b9
- Author
- Marc Cornellà <marc.cornella@live.com>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
Clean up plugin READMEs and a few plugins - fasd - history - mercurial - pylint - repo - yii2
Diff
This diff is truncated to protect this page.
1diff --git a/plugins/apache2-macports/README.md b/plugins/apache2-macports/README.md
2index 099fc8da31dbe0fb2850e3336c45357b14ec5dbd..dbf2e89a2fdbd4216968ed73f10f9305c4efac5e 100644
3--- a/plugins/apache2-macports/README.md
4+++ b/plugins/apache2-macports/README.md
5@@ -1,19 +1,21 @@
6-## APACHE2 MACPORTS PLUGIN
7+# apache2-macports plugin
8
9+Enables aliases to control a local Apache2 installed via [MacPorts](https://www.macports.org/).
10
11----
12+To use it, add `apache2-macports` to the plugins array in your zshrc file:
13
14-### FEATURES
15+```zsh
16+plugins=(... apache2-macports)
17+```
18
19-| Alias | Function | Description |
20-|:--------------:|:-------------------------------------------------------------------------------|----------------------:|
21-| apache2restart | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper restart | Restart apache daemon |
22-| apache2start | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper start | Start apache daemon |
23-| apache2stop | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper stop | Stop apache daemon |
24+## Aliases
25
26----
27+| Alias | Function | Description |
28+|----------------|-----------------------------------------|-----------------------|
29+| apache2restart | `sudo /path/to/apache2.wrapper restart` | Restart apache daemon |
30+| apache2start | `sudo /path/to/apache2.wrapper start` | Start apache daemon |
31+| apache2stop | `sudo /path/to/apache2.wrapper stop` | Stop apache daemon |
32
33-### CONTRIBUTORS
34- - Alexander Rinass (alex@rinass.net)
35+## Contributors
36
37----
38+- Alexander Rinass (alex@rinass.net)
39diff --git a/plugins/archlinux/README.md b/plugins/archlinux/README.md
40index 9cbfe3742c8a22001ef8b5b0c1aa343a7f022d12..5882c7603594ef16f1a8db8fb442bf4a8bf86e3b 100644
41--- a/plugins/archlinux/README.md
42+++ b/plugins/archlinux/README.md
43@@ -1,5 +1,13 @@
44 # Archlinux plugin
45
46+This plugin adds some aliases and functions to work with Arch Linux.
47+
48+To use it, add `archlinux` to the plugins array in your zshrc file:
49+
50+```zsh
51+plugins=(... archlinux)
52+```
53+
54 ## Features
55
56 #### YAY
57diff --git a/plugins/bower/README.md b/plugins/bower/README.md
58index 743b6a0ea9e451f082d4d79c40f41054896d7f66..8877fbdc5a8139ab1382d026221cde88e168b6e2 100644
59--- a/plugins/bower/README.md
60+++ b/plugins/bower/README.md
61@@ -4,7 +4,7 @@ This plugin adds completion for [Bower](https://bower.io/) and a few useful alia
62
63 To use it, add `bower` to the plugins array in your zshrc file:
64
65-```
66+```zsh
67 plugins=(... bower)
68 ```
69
70@@ -15,4 +15,3 @@ plugins=(... bower)
71 | bi | `bower install` | Installs the project dependencies listed in bower.json |
72 | bl | `bower list` | List local packages and possible updates |
73 | bs | `bower search` | Finds all packages or a specific package. |
74-
75diff --git a/plugins/cake/README.md b/plugins/cake/README.md
76index aad92a3eccf42ca624d0f07840ca26008396bcec..2c2a2805358b48110b5c6eff2cac23d8819969c0 100644
77--- a/plugins/cake/README.md
78+++ b/plugins/cake/README.md
79@@ -10,6 +10,6 @@ plugins=(... cake)
80
81 ## Note
82
83-This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory.
84+This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory.
85 It is regenerated when the Cakefile is newer than the cache file. It is advised that you add the cake file to your
86 `.gitignore` files.
87diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md
88index 42b59a62c3db3ac955471aff6203dee3da2d9487..8f268805072d639298fdd18e461bdae888e60b56 100644
89--- a/plugins/catimg/README.md
90+++ b/plugins/catimg/README.md
91@@ -2,27 +2,15 @@
92
93 Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
94
95-## Requirements
96-
97-- `convert` (ImageMagick)
98-
99-## Enabling the plugin
100+To use it, add `catimg` to the plugins array in your zshrc file:
101
102-1. Open your `.zshrc` file and add `catimg` in the plugins section:
103+```zsh
104+plugins=(... catimg)
105+```
106
107- ```zsh
108- plugins=(
109- # all your enabled plugins
110- catimg
111- )
112- ```
113-
114-2. Restart the shell or restart your Terminal session:
115+## Requirements
116
117- ```console
118- $ exec zsh
119- $
120- ```
121+- `convert` (ImageMagick)
122
123 ## Functions
124
125diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md
126index be7b97e2475fbadfbd05d5a014d950cf54a421ec..35f98918058d8c90bf1c2184106147be5f5f617e 100644
127--- a/plugins/chucknorris/README.md
128+++ b/plugins/chucknorris/README.md
129@@ -1,6 +1,6 @@
130 # chucknorris
131
132-Chuck Norris fortunes plugin for oh-my-zsh
133+Chuck Norris fortunes plugin for oh-my-zsh. Perfectly suitable as MOTD.
134
135 **Maintainers**: [apjanke](https://github.com/apjanke) [maff](https://github.com/maff)
136
137@@ -10,11 +10,31 @@ To use it add `chucknorris` to the plugins array in you zshrc file.
138 plugins=(... chucknorris)
139 ```
140
141-
142-Depends on fortune (and cowsay if using chuck_cow) being installed (available via homebrew, apt, ...). Perfectly suitable as MOTD.
143-
144+## Usage
145
146 | Command | Description |
147 | ----------- | ------------------------------- |
148 | `chuck` | Print random Chuck Norris quote |
149 | `chuck_cow` | Print quote in cowthink |
150+
151+Example: output of `chuck_cow`:
152+
153+```
154+Last login: Fri Jan 30 23:12:26 on ttys001
155+ ______________________________________
156+( When Chuck Norris plays Monopoly, it )
157+( affects the actual world economy. )
158+ --------------------------------------
159+ o ^__^
160+ o (oo)\_______
161+ (__)\ )\/\
162+ ||----w |
163+ || ||
164+```
165+
166+## Requirements
167+
168+- `fortune`
169+- `cowsay` if using `chuck_cow`
170+
171+Available via homebrew, apt, ...
172diff --git a/plugins/cloudapp/README.md b/plugins/cloudapp/README.md
173index 6c7f9bc6cea6b2a9ce0d6066caf1fa7364cd95a2..fc9fc32bdb8bb2c62e719858c2b191ebefd867fb 100644
174--- a/plugins/cloudapp/README.md
175+++ b/plugins/cloudapp/README.md
176@@ -4,7 +4,7 @@
177
178 To use it, add `cloudapp` to the plugins array of your `~/.zshrc` file:
179
180-```
181+```zsh
182 plugins=(... cloudapp)
183 ```
184
185diff --git a/plugins/coffee/README.md b/plugins/coffee/README.md
186index d6cd074d3d74dc651d8bf996249893228e87ece9..2baade844b732853885c787baf8e86b3ba0826ea 100644
187--- a/plugins/coffee/README.md
188+++ b/plugins/coffee/README.md
189@@ -1,4 +1,4 @@
190-## Coffeescript Plugin
191+# Coffeescript Plugin
192
193 This plugin provides aliases for quickly compiling and previewing your
194 coffeescript code.
195diff --git a/plugins/compleat/README.md b/plugins/compleat/README.md
196index 630c91503428066bdae9752848f6460322dceedd..af0e383beb0571e80d09e953d9d6aa0f2b4c4773 100644
197--- a/plugins/compleat/README.md
198+++ b/plugins/compleat/README.md
199@@ -3,6 +3,7 @@
200 This plugin looks for [compleat](https://github.com/mbrubeck/compleat) and loads its completion.
201
202 To use it, add compleat to the plugins array in your zshrc file:
203-```
204+
205+```zsh
206 plugins=(... compleat)
207 ```
208diff --git a/plugins/composer/README.md b/plugins/composer/README.md
209index 2b4bae5790d70ba2649eab9ba188480587e519b3..85eef3cc71b8de3b5303b8fc60c053d118fda5ce 100644
210--- a/plugins/composer/README.md
211+++ b/plugins/composer/README.md
212@@ -12,18 +12,18 @@ plugins=(... composer)
213
214 ## Aliases
215
216-| Alias | Command | Description |
217-| ------ | -------------------------------------------- | -------------------------------------------------------------------------------------- |
218-| `c` | composer | Starts composer |
219-| `csu` | composer self-update | Updates composer to the latest version |
220-| `cu` | composer update | Updates composer dependencies and `composer.lock` file |
221-| `cr` | composer require | Adds new packages to `composer.json` |
222-| `crm` | composer remove | Removes packages from `composer.json` |
223-| `ci` | composer install | Resolves and installs dependencies from `composer.json` |
224-| `ccp` | composer create-project | Create new project from an existing package |
225-| `cdu` | composer dump-autoload | Updates the autoloader |
226-| `cdo` | composer dump-autoload --optimize-autoloader | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) |
227-| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory |
228-| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory |
229-| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory |
230-| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory |
231+| Alias | Command | Description |
232+| ------ | ---------------------------------------------- | -------------------------------------------------------------------------------------- |
233+| `c` | `composer` | Starts composer |
234+| `csu` | `composer self-update` | Updates composer to the latest version |
235+| `cu` | `composer update` | Updates composer dependencies and `composer.lock` file |
236+| `cr` | `composer require` | Adds new packages to `composer.json` |
237+| `crm` | `composer remove` | Removes packages from `composer.json` |
238+| `ci` | `composer install` | Resolves and installs dependencies from `composer.json` |
239+| `ccp` | `composer create-project` | Create new project from an existing package |
240+| `cdu` | `composer dump-autoload` | Updates the autoloader |
241+| `cdo` | `composer dump-autoload --optimize-autoloader` | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) |
242+| `cgu` | `composer global update` | Allows update command to run on COMPOSER_HOME directory |
243+| `cgr` | `composer global require` | Allows require command to run on COMPOSER_HOME directory |
244+| `cgrm` | `composer global remove` | Allows remove command to run on COMPOSER_HOME directory |
245+| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory |
246diff --git a/plugins/copyfile/README.md b/plugins/copyfile/README.md
247index 53138ad0653c8a05beed00939a815ad8c06a2488..a110b83fe47c4e7ad4b7b75113d556fb687bea34 100644
248--- a/plugins/copyfile/README.md
249+++ b/plugins/copyfile/README.md
250@@ -3,7 +3,8 @@
251 Puts the contents of a file in your system clipboard so you can paste it anywhere.
252
253 To use, add `copyfile` to your plugins array:
254-```
255+
256+```zsh
257 plugins=(... copyfile)
258 ```
259
260diff --git a/plugins/cpanm/README.md b/plugins/cpanm/README.md
261index 3803e3e0074d5802b980ef4e6701cb35085d48ea..13e93d0a5a4211a6c6654b26828716e039d0f68d 100644
262--- a/plugins/cpanm/README.md
263+++ b/plugins/cpanm/README.md
264@@ -1,9 +1,9 @@
265 # Cpanm
266
267 This plugin provides completion for [Cpanm](https://github.com/miyagawa/cpanminus) ([docs](https://metacpan.org/pod/App::cpanminus)).
268-
269+
270 To use it add cpanm to the plugins array in your zshrc file.
271-
272- ```bash
273+
274+```zsh
275 plugins=(... cpanm)
276 ```
277diff --git a/plugins/dirhistory/README.md b/plugins/dirhistory/README.md
278index 511f2be178d36436fd8ac3d9f53e8622a717552b..22365072772f3beb07663c804d9c56c8ed7ac8ee 100644
279--- a/plugins/dirhistory/README.md
280+++ b/plugins/dirhistory/README.md
281@@ -7,6 +7,7 @@ To use it, add `dirhistory` to the plugins array in your zshrc file:
282 ```zsh
283 plugins=(... dirhistory)
284 ```
285+
286 ## Keyboard Shortcuts
287
288 | Shortcut | Description |
289@@ -15,3 +16,24 @@ plugins=(... dirhistory)
290 | <kbd>alt</kbd> + <kbd>right</kbd> | Undo <kbd>alt</kbd> + <kbd>left</kbd> |
291 | <kbd>alt</kbd> + <kbd>up</kbd> | Move into the parent directory |
292 | <kbd>alt</kbd> + <kbd>down</kbd> | Move into the first child directory by alphabetical order |
293+
294+## Usage
295+
296diff --git a/plugins/dirpersist/README.md b/plugins/dirpersist/README.md
297index 9880bc5635e8723837af37dbd7534217c5afe4f0..792fb4bfe570bc4a20986adc37df40ebaf1b56da 100644
298--- a/plugins/dirpersist/README.md
299+++ b/plugins/dirpersist/README.md
300@@ -1,6 +1,7 @@
301 # Dirpersist plugin
302
303-This plugin keeps a running tally of the previous 20 unique directories in the $HOME/.zdirs file. When you cd to a new directory, it is prepended to the beginning of the file.
304+This plugin keeps a running tally of the previous 20 unique directories in the `$HOME/.zdirs` file.
305+When you cd to a new directory, it is prepended to the beginning of the file.
306
307 To use it, add `dirpersist` to the plugins array in your zshrc file:
308
309diff --git a/plugins/django/README.md b/plugins/django/README.md
310index 415f6b7eaaaa0de1a836bb6aa71745c7b9a619f6..1740e55e56854592820a78b6da00d32bd1c28d4e 100644
311--- a/plugins/django/README.md
312+++ b/plugins/django/README.md
313@@ -34,23 +34,3 @@ runfcgi -- run this project as a fastcgi
314 runserver -- start a lightweight web server for development
315 ...
316 ```
317-
318-If you want to see the options available for a specific command, try:
319-
320-```zsh
321-$> python manage.py makemessages (press <TAB> here)
322-```
323-
324-And that would result in:
325-
326-```zsh
327---all -a -- re-examine all code and templates
328---domain -d -- domain of the message files (default: "django")
329---extensions -e -- file extension(s) to examine (default: ".html")
330---help -- display help information
331---locale -l -- locale to process (default: all)
332---pythonpath -- directory to add to the Python path
333---settings -- python path to settings module
334-...
335-```
336-
337diff --git a/plugins/dnf/README.md b/plugins/dnf/README.md
338index f9ef496fa7ec4f4fddc21960a1c5a0b2746f8b66..dc0d1e0a08b0e75b18860945d81bec0480723d22 100644
339--- a/plugins/dnf/README.md
340+++ b/plugins/dnf/README.md
341@@ -1,10 +1,14 @@
342-## Description
343+# dnf plugin
344
345-This plugin makes `dnf` usage easier by adding aliases for the most
346-common commands.
347+This plugin makes `dnf` usage easier by adding aliases for the most common commands.
348
349-`dnf` is the new package manager for RPM-based distributions, which
350-replaces `yum`.
351+`dnf` is the new package manager for RPM-based distributions, which replaces `yum`.
352+
353+To use it, add `dnf` to the plugins array in your zshrc file:
354+
355+```zsh
356+plugins=(... dnf)
357+```
358
359 ## Aliases
360
361diff --git a/plugins/docker-compose/README.md b/plugins/docker-compose/README.md
362index 07a87bc81f0e47d6a2390be60facd52eb8855cd1..1105e03f6e39dd70d0cb258a28181733eaa263e5 100644
363--- a/plugins/docker-compose/README.md
364+++ b/plugins/docker-compose/README.md
365@@ -4,7 +4,8 @@ This plugin provides completion for [docker-compose](https://docs.docker.com/com
366 aliases for frequent docker-compose commands.
367
368 To use it, add docker-compose to the plugins array of your zshrc file:
369-```
370+
371+```zsh
372 plugins=(... docker-compose)
373 ```
374
375diff --git a/plugins/docker/README.md b/plugins/docker/README.md
376index 4d9f3ae9bce16b358f3daf3924bbeb49736d76dc..241a6a448444a5784a8d15b5326e7f9f928df2bf 100644
377--- a/plugins/docker/README.md
378+++ b/plugins/docker/README.md
379@@ -3,6 +3,7 @@
380 This plugin adds auto-completion for [docker](https://www.docker.com/).
381
382 To use it add `docker` to the plugins array in your zshrc file.
383+
384 ```zsh
385 plugins=(... docker)
386 ```
387diff --git a/plugins/encode64/README.md b/plugins/encode64/README.md
388index 66fc7cba49abb59bd022188e3a159ff7ccb4eb7d..a83a3d3d2099959351b88252743809518ac42124 100644
389--- a/plugins/encode64/README.md
390+++ b/plugins/encode64/README.md
391@@ -1,6 +1,12 @@
392 # encode64
393
394-Alias plugin for encoding or decoding using `base64` command
395+Alias plugin for encoding or decoding using `base64` command.
396+
397+To use it, add `encode64` to the plugins array in your zshrc file:
398+
399+```zsh
400+plugins=(... encode64)
401+```
402
403 ## Functions and Aliases
404
405@@ -9,23 +15,6 @@ Alias plugin for encoding or decoding using `base64` command
406 | `encode64` | `e64` | Encodes given data to base64 |
407 | `decode64` | `d64` | Decodes given data from base64 |
408
409-## Enabling plugin
410-
411-1. Edit your `.zshrc` file and add `encode64` to the list of plugins:
412-
413- ```sh
414- plugins=(
415- # ...other enabled plugins
416- encode64
417- )
418- ```
419-
420-2. Restart your terminal session or restart the shell:
421-
422- ```sh
423- exec zsh
424- ```
425-
426 ## Usage and examples
427
428 ### Encoding
429diff --git a/plugins/fabric/README.md b/plugins/fabric/README.md
430index cf0fa81f4249e12e54faffb3180f23abb0a5af30..f121d2ed8a5a3c9671ab39be41610d3de864ec2f 100644
431--- a/plugins/fabric/README.md
432+++ b/plugins/fabric/README.md
433@@ -4,6 +4,6 @@ This plugin provides completion for [Fabric](https://www.fabfile.org/).
434
435 To use it add fabric to the plugins array in your zshrc file.
436
437-```bash
438+```zsh
439 plugins=(... fabric)
440 ```
441diff --git a/plugins/fasd/fasd.plugin.zsh b/plugins/fasd/fasd.plugin.zsh
442index cdf99708c548eeaa313406611551225483ab7609..6538d097eb17a0b2bc707b57ab6a258b04596e16 100644
443--- a/plugins/fasd/fasd.plugin.zsh
444+++ b/plugins/fasd/fasd.plugin.zsh
445@@ -1,13 +1,16 @@
446-if [ $commands[fasd] ]; then # check if fasd is installed
447- fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache"
448- if [ "$(command -v fasd)" -nt "$fasd_cache" -o ! -s "$fasd_cache" ]; then
449- fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \
450- zsh-wcomp zsh-wcomp-install >| "$fasd_cache"
451- fi
452- source "$fasd_cache"
453- unset fasd_cache
454+# check if fasd is installed
455+if (( ! ${+commands[fasd]} )); then
456+ return
457+fi
458
459- alias v='f -e "$EDITOR"'
460- alias o='a -e xdg-open'
461- alias j='zz'
462+fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache"
463+if [[ "$commands[fasd]" -nt "$fasd_cache" || ! -s "$fasd_cache" ]]; then
464+ fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \
465+ zsh-wcomp zsh-wcomp-install >| "$fasd_cache"
466 fi
467+source "$fasd_cache"
468+unset fasd_cache
469+
470+alias v='f -e "$EDITOR"'
471+alias o='a -e xdg-open'
472+alias j='zz'
473diff --git a/plugins/fbterm/README.md b/plugins/fbterm/README.md
474index eec33d7ee676e30d24e3b797d1b8f097c6d76747..70ce56da87f1e90dee483e6890bfca4b33bfe136 100644
475--- a/plugins/fbterm/README.md
476+++ b/plugins/fbterm/README.md
477@@ -3,7 +3,8 @@
478 This plugin automatically starts [fbterm](https://github.com/zhangyuanwei/fbterm)
479 if on a real TTY (`/dev/tty*`).
480
481-To use it, add fbterm to the plugins array of your zshrc file:
482-```
483+To use it, add `fbterm` to the plugins array of your zshrc file:
484+
485+```zsh
486 plugins=(... fbterm)
487 ```
488diff --git a/plugins/forklift/README.md b/plugins/forklift/README.md
489index 6c4ce1e81e0103c4c02476545c71c9febc1bcf77..7dfd8bf9576ae76cc791a0ad7e9283e410946a83 100644
490--- a/plugins/forklift/README.md
491+++ b/plugins/forklift/README.md
492@@ -1,15 +1,23 @@
493-## forklift
494+# forklift
495
496 Plugin for ForkLift, an FTP application for OS X.
497
498-### Requirements
499+To use it, add `forklift` to the plugins array in your zshrc file:
500+
501+```zsh
502+plugins=(... forklift)
503+```
504+
505+## Requirements
506
507 * [ForkLift](https://binarynights.com/)
508
509-### Usage
510+## Usage
511
512-<code>fl [*file_or_folder*]</code>
513+`fl [<file_or_folder>]`
514
515 * If `fl` is called without arguments then the current folder is opened in ForkLift. This is equivalent to `fl .`.
516
517-* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift. If called with a non-directory file as the argument, then the file's parent directory is opened.
518+* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift
519+
520+* If `fl` is called with a non-directory file as the argument, then the file's parent directory is opened.
521diff --git a/plugins/gas/README.md b/plugins/gas/README.md
522index cd8800e7d1b172f7f938502988cbe33a3e15cbec..47b3fb9df9ce680ae250905d0babc3f7d75de532 100644
523--- a/plugins/gas/README.md
524+++ b/plugins/gas/README.md
525@@ -4,6 +4,7 @@ This plugin adds autocompletion for the [gas](http://walle.github.com/gas) comma
526 a utility to manage Git authors.
527
528 To use it, add `gas` to the plugins array of your zshrc file:
529+
530 ```zsh
531 plugins=(... gas)
532 ```
533diff --git a/plugins/geeknote/README.md b/plugins/geeknote/README.md
534index 99c1fbf5b06f438bc858cb77e5fb9f92b6a5498c..95b3aa7ddf52903d8ba75ff5766a224f84b8aeb5 100644
535--- a/plugins/geeknote/README.md
536+++ b/plugins/geeknote/README.md
537@@ -1,19 +1,10 @@
538-ZSH-Geeknote
539-============
540+# Geeknote plugin
541
542-[Geeknote](https://github.com/VitaliyRodnenko/geeknote) plugin for oh-my-zsh.
543+This plugin provides autocompletion for [Geeknote](https://github.com/VitaliyRodnenko/geeknote)
544+and an alias for `geeknote` called `gn`.
545
546-Plugins provides:
547+To use it, add `geeknote` to the plugins array in your zshrc file:
548
549-* auto completion of commands and their options
550-* alias `gn`
551-
552-## Installation
553-
554-### oh-my-zsh
555-This plugin is already bundled in oh-my-zsh. To enable just configure plugin definition
556-
557- plugins=( ... geeknote ...)
558-
559-### Antigen
560-Use [Antigen's](https://github.com/zsh-users/antigen) bundle command to install by adding `antigen bundle s7anley/zsh-geeknote` to your `.zshrc` along with your other plugins.
561+```zsh
562+plugins=( ... geeknote ...)
563+```
564diff --git a/plugins/git-extras/README.md b/plugins/git-extras/README.md
565index 987f0d80024761a5e1f526c6622449a5ca98edf5..2adc9d477009e397a0010ff284c19b7524cdc233 100644
566--- a/plugins/git-extras/README.md
567+++ b/plugins/git-extras/README.md
568@@ -2,10 +2,16 @@
569
570 This plugin provides completion definitions for some of the commands defined by [git-extras](https://github.com/tj/git-extras).
571
572-## Setup notes
573+To use it, add `git-extras` to the plugins array in your zshrc file:
574+
575+```zsh
576+plugins=(... git-extras)
577+```
578+
579+## Setup notes
580
581diff --git a/plugins/git-flow/README.md b/plugins/git-flow/README.md
582index 5d8049e3bde2f1cafdcff3044bcde63a7808c917..9c25dec83c78602e71892e9839f3c80a77e9faf9 100644
583--- a/plugins/git-flow/README.md
584+++ b/plugins/git-flow/README.md
585@@ -1,18 +1,15 @@
586 # Git-Flow plugin
587
588-This plugin adds completion and aliases for the `git-flow` command. More information
589-at https://github.com/nvie/gitflow.
590+This plugin adds completion and aliases for the [`git-flow` command](https://github.com/nvie/gitflow).
591
592-Enable git-flow plugin in your zshrc file:
593-```
594+To use it, add `git-flow` to the plugins array in your zshrc file:
595+
596+```zsh
597 plugins=(... git-flow)
598 ```
599
600 ## Aliases
601
602-More information about `git-flow` commands:
603-https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
604-
605 | Alias | Command | Description |
606 |---------|----------------------------|----------------------------------------|
607 | `gfl` | `git flow` | Git-Flow command |
608@@ -30,3 +27,5 @@ https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
609 | `gflfp` | `git flow feature publish` | Publish feature: `gflfp <name>` |
610 | `gflhf` | `git flow hotfix finish` | Finish hotfix: `gflhf <version>` |
611 | `gflrf` | `git flow release finish` | Finish release: `gflrf <version>` |
612+
613+[More information about `git-flow` commands](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments).
614diff --git a/plugins/git-remote-branch/README.md b/plugins/git-remote-branch/README.md
615index bd73e5dec0b58944490727ac3f53b669663053e8..d4eb75954d648b56564364977833aa811373b6ee 100644
616--- a/plugins/git-remote-branch/README.md
617+++ b/plugins/git-remote-branch/README.md
618@@ -3,8 +3,9 @@
619 This plugin adds completion for [`grb`](https://github.com/webmat/git_remote_branch),
620 or `git_remote_branch`.
621
622-To use it, add `git-remote-branch` to the plugins array of your `.zshrc` file:
623-```
624+To use it, add `git-remote-branch` to the plugins array of your zshrc file:
625+
626+```zsh
627 plugins=(... git-remote-branch)
628 ```
629
630diff --git a/plugins/git/README.md b/plugins/git/README.md
631index 4799b1cddb14e887fd3d3edcf32d32463fe1238d..64a3b2209ab043077d0a9748e88d8d778f026f47 100644
632--- a/plugins/git/README.md
633+++ b/plugins/git/README.md
634@@ -172,7 +172,7 @@ plugins=(... git)
635 | gwch | git whatchanged -p --abbrev-commit --pretty=medium |
636 | gwip | git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign -m "--wip-- [skip ci]" |
637
638-### Deprecated
639+### Deprecated aliases
640
641 These are aliases that have been removed, renamed, or otherwise modified in a way that may, or may not, receive further support.
642
643@@ -211,7 +211,7 @@ These features allow to pause a branch development and switch to another one (_"
644 | gwip | Commit wip branch |
645 | gunwip | Uncommit wip branch |
646
647-### Deprecated
648+### Deprecated functions
649
650 | Command | Description | Reason |
651 |:-----------------------|:----------------------------------------|:----------------------------------------------------------------|
652diff --git a/plugins/gitfast/README.md b/plugins/gitfast/README.md
653index 23db5393b00c76ecb9583035ffcd7c0826821c3b..fed4b120afc7b73ad0cf7795bfd69ab525a9f83b 100644
654--- a/plugins/gitfast/README.md
655+++ b/plugins/gitfast/README.md
656@@ -1,6 +1,6 @@
657 # Gitfast plugin
658
659diff --git a/plugins/github/README.md b/plugins/github/README.md
660index 2b66e390fd0d4fe6f81ec742af495ebbd7907241..70b863f64492f462ef6d6a660d0e1ae371cb6fce 100644
661--- a/plugins/github/README.md
662+++ b/plugins/github/README.md
663@@ -1,4 +1,4 @@
664-# github
665+# github plugin
666
667 This plugin supports working with GitHub from the command line. It provides a few things:
668
669@@ -6,7 +6,7 @@ This plugin supports working with GitHub from the command line. It provides a fe
670 * Completion for the `github` Ruby gem.
671 * Convenience functions for working with repos and URLs.
672
673-### Functions
674+### Functions
675
676 * `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub
677 * `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub
678@@ -14,13 +14,13 @@ This plugin supports working with GitHub from the command line. It provides a fe
679 * `git.io` - Shortens a URL using [git.io](https://git.io)
680
681
682-## Installation
683+## Installation
684
685 [Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ.
686
687 The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it.
688
689-### Configuration
690+### Configuration
691
692 These settings affect `github`'s behavior.
693
694@@ -35,7 +35,7 @@ These settings affect `github`'s behavior.
695
696 See `man hub` for more details.
697
698-### Homebrew installation note
699+### Homebrew installation note
700
701diff --git a/plugins/gpg-agent/README.md b/plugins/gpg-agent/README.md
702index a9711f9234d50ba09dc259f5f5ce5aef9c87af76..9c1e6d2cca73f15f286820a7dc3cb9f25282309f 100644
703--- a/plugins/gpg-agent/README.md
704+++ b/plugins/gpg-agent/README.md
705@@ -3,6 +3,7 @@
706 Enables [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/) if it is not running.
707
708 To use it, add gpg-agent to the plugins array of your zshrc file:
709-```
710+
711+```zsh
712 plugins=(... gpg-agent)
713 ```
714diff --git a/plugins/gradle/README.md b/plugins/gradle/README.md
715index a94ac3d0de76df014f74bc5368cd574fbf6338f5..3756db0dc41b5d0c84847988b8a9f7a02748b7ac 100644
716--- a/plugins/gradle/README.md
717+++ b/plugins/gradle/README.md
718@@ -18,6 +18,7 @@ whether it is `gradle` or `gradlew`. It also supports being called from
719 any directory inside the root project directory.
720
721 Examples:
722+
723 ```zsh
724 gradle test
725 gradle build
726diff --git a/plugins/grails/README.md b/plugins/grails/README.md
727index 64b4a9f07507f1a4b25603d7fbb65466e765b610..5d9ebd77d0481f9a31f7356fc4ce5d3037c13652 100644
728--- a/plugins/grails/README.md
729+++ b/plugins/grails/README.md
730@@ -14,58 +14,3 @@ It looks for scripts in the following paths:
731 - `~/.grails/scripts`
732 - `./scripts`
733 - `./plugins/*/scripts`
734-
735-## Grails Commands
736-- `add-proxy`
737-- `alias`
738-- `bootstrap`
739-- `bug-report`
740-- `clean`
741-- `clean-all`
742-- `clear-proxy`
743-- `compile`
744-- `console`
745-- `create-app`
746-- `create-controller`
747-- `create-domain-class`
748-- `create-filters`
749-- `create-integration-test`
750-- `create-multi-project-build`
751-- `create-plugin`
752-- `create-pom`
753-- `create-script`
754-- `create-service`
755-- `create-tag-lib`
756-- `create-unit-test`
757-- `dependency-report`
758-- `doc`
759-- `help`
760-- `init`
761-- `install-app-templates`
762-- `install-dependency`
763-- `install-plugin`
764-- `install-templates`
765-- `integrate-with`
766-- `interactive`
767-- `list-plugin-updates`
768-- `list-plugins`
769-- `migrate-docs`
770-- `package`
771-- `package-plugin`
772-- `plugin-info`
773-- `refresh-dependencies`
774-- `remove-proxy`
775-- `run-app`
776-- `run-script`
777-- `run-war`
778-- `set-grails-version`
779-- `set-proxy`
780-- `set-version`
781-- `shell`
782-- `stats`
783-- `stop-app`
784-- `test-app`
785-- `uninstall-plugin`
786-- `url-mappings-report`
787-- `war`
788-- `wrapper`
789diff --git a/plugins/history/README.md b/plugins/history/README.md
790index dd9286894ba31aa693160b66e9700cd117d6c612..a9d480f46b2299a11ea226f69cfb7adb6e8b08fe 100644
791--- a/plugins/history/README.md
792+++ b/plugins/history/README.md
793@@ -1,15 +1,17 @@
794-## history
795+# history plugin
796
797 Provides a couple of convenient aliases for using the `history` command to examine your command line history.
798
799-### Requirements
800+To use it, add `history` to the plugins array in your zshrc file:
801
802-* None.
803+```zsh
804+plugins=(... history)
805+```
806
807-### Usage
808+## Aliases
809
810-* If `h` is called, your command history is listed. Equivalent to using `history`
811-
812-* If `hsi` is called with an argument, a **case insensitive** `grep` search is performed on your command history, looking for commands that match the argument provided
813-
814-* If `hsi` is called without an argument you will help on `grep` arguments
815+| Alias | Command | Description |
816+|-------|----------------------|------------------------------------------------------------------|
817+| `h` | `history` | Prints your command history |
818+| `hs` | `history \| grep` | Use grep to search your command history |
819+| `hsi` | `history \| grep -i` | Use grep to do a case-insensitive search of your command history |
820diff --git a/plugins/history/history.plugin.zsh b/plugins/history/history.plugin.zsh
821index 0f4aa4b10720d359d48cbac77c86234bf26f56a3..9cee48fe4b7c7f3c680c31af299b97fe1e4475fa 100644
822--- a/plugins/history/history.plugin.zsh
823+++ b/plugins/history/history.plugin.zsh
824@@ -1,8 +1,3 @@
825 alias h='history'
826-
827-function hs
828-{
829- history | grep $*
830-}
831-
832-alias hsi='hs -i'
833+alias hs='history | grep'
834+alias hsi='history | grep -i'
835diff --git a/plugins/httpie/README.md b/plugins/httpie/README.md
836index f22d3a64e514fa74bbddaadabe9a1e327467f490..25bdd0c7d477639bd49fdfa13225d7e8e7b70902 100644
837--- a/plugins/httpie/README.md
838+++ b/plugins/httpie/README.md
839@@ -11,5 +11,4 @@ plugins=(... httpie)
840
841 It uses completion from [zsh-completions](https://github.com/zsh-users/zsh-completions).
842
843-
844 **Maintainer:** [lululau](https://github.com/lululau)
845diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md
846index 4faf58b98ead4edaabf24c77d5ebefe61c0a88ed..2a5a76139d45b4e995ae3b28fde59d61d88071e1 100644
847--- a/plugins/jsontools/README.md
848+++ b/plugins/jsontools/README.md
849@@ -2,41 +2,47 @@
850
851 Handy command line tools for dealing with json data.
852
853-## Tools
854+To use it, add `jsontools` to the plugins array in your zshrc file:
855
856-- **pp_json** - pretty prints json
857-- **is_json** - returns true if valid json; false otherwise
858-- **urlencode_json** - returns a url encoded string for the given json
859-- **urldecode_json** - returns decoded json for the given url encoded string
860+```zsh
861+plugins=(... jsontools)
862+```
863
864 ## Usage
865-Usage is simple...just take your json data and pipe it into the appropriate jsontool.
866-```sh
867-<json data> | <jsontools tool>
868-```
869-## Examples
870
871-##### pp_json
872+Usage is simple... just take your json data and pipe it into the appropriate jsontool:
873+
874+- `pp_json`: pretty prints json.
875+- `is_json`: returns true if valid json; false otherwise.
876+- `urlencode_json`: returns a url encoded string for the given json.
877+- `urldecode_json`: returns decoded json for the given url encoded string.
878+
879+### Examples
880+
881+- **pp_json**:
882
883 ```sh
884 # curl json data and pretty print the results
885 curl https://coderwall.com/bobwilliams.json | pp_json
886 ```
887
888-##### is_json
889+- **is_json**:
890+
891 ```sh
892 # pretty print the contents of an existing json file
893 less data.json | is_json
894 ```
895
896-##### urlencode_json
897+- **urlencode_json**:
898+
899 ```sh
900 # json data directly from the command line
901 echo '{"b":2, "a":1}' | urlencode_json
902 ```
903
904-##### urldecode_json
905+- **urldecode_json**:
906+
907 ```sh
908 # url encoded string to decode
909 echo '%7B%22b%22:2,%20%22a%22:1%7D%0A' | urldecode_json
910-```
911+```
912diff --git a/plugins/laravel4/README.md b/plugins/laravel4/README.md
913index c945601f770cdbf43df8f23695a2d5938eeb989d..97a6a7899431b33c7449a16e48d84bc99e53a518 100644
914--- a/plugins/laravel4/README.md
915+++ b/plugins/laravel4/README.md
916@@ -10,9 +10,9 @@ plugins=(... laravel4)
917
918 ## Aliases
919
920-| Alias | Command | Description |
921-|-----------|-------------------------------------------|-------------------------------------------------------------|
922-| la4 | `php artisan` | Main Artisan command |
923-| la4dump | `php artisan dump-autoload` | Regenerate framework autoload files |
924-| la4cache | `php artisan cache:clear` | Flush the application cache |
925-| la4routes | `php artisan routes` | List all registered routes |
926+| Alias | Command | Description |
927+|-----------|-----------------------------|-------------------------------------|
928+| la4 | `php artisan` | Main Artisan command |
929+| la4dump | `php artisan dump-autoload` | Regenerate framework autoload files |
930+| la4cache | `php artisan cache:clear` | Flush the application cache |
931+| la4routes | `php artisan routes` | List all registered routes |
932diff --git a/plugins/last-working-dir/README.md b/plugins/last-working-dir/README.md
933index 4cc4acab63c5961d74f9e19cc5a43267838d7042..ced9e0370d315b426493a5269d08e4b904a191d8 100644
934--- a/plugins/last-working-dir/README.md
935+++ b/plugins/last-working-dir/README.md
936@@ -6,4 +6,10 @@ for new shells, unless:
937 - The plugin is already loaded.
938 - The current `$PWD` is not `$HOME`.
939
940-Adds `lwd` function to jump to the last working directory.
941+Also adds `lwd` function to jump to the last working directory.
942+
943+To use it, add `last-working-dir` to the plugins array in your zshrc file:
944+
945+```zsh
946+plugins=(... last-working-dir)
947+```
948diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md
949index 0db29b4e582537082ff87db22f07470df8cf98fd..55587b20e964b8690e483af408f1fc614eb8c6ae 100644
950--- a/plugins/lighthouse/README.md
951+++ b/plugins/lighthouse/README.md
952@@ -16,7 +16,8 @@ plugins=(... lighthouse)
953 file in your directory with the URL to the individual project.
954
955 Example:
956- ```zsh
957+
958+ ```console
959 $ cat .lighthouse-url
960 https://rails.lighthouseapp.com/projects/8994
961
962@@ -24,3 +25,5 @@ plugins=(... lighthouse)
963 Opening ticket #23
964 # The browser goes to https://rails.lighthouseapp.com/projects/8994/tickets/23
965 ```
966+
967+See a demo: http://screencast.com/t/ZDgwNDUwNT
968diff --git a/plugins/lol/README.md b/plugins/lol/README.md
969index 1791de493e7a1d401370cbaa87b958e9ea560b11..ea6b0c3b88582aa92abf07bc577d302767366edd 100644
970--- a/plugins/lol/README.md
971+++ b/plugins/lol/README.md
972@@ -1,67 +1,55 @@
973 # lol
974
975-Plugin for adding catspeak aliases, because why not
976+Plugin for adding catspeak aliases, because why not.
977
978-## Enabling the plugin
979+To use it, add `lol` to the plugins array in your zshrc file:
980
981-1. Open your `.zshrc` file and add `lol` in the plugins section:
982-
983- ```zsh
984- plugins=(
985- # all your enabled plugins
986- lol
987- )
988- ```
989-
990-2. Restart your terminal session or restart the shell:
991-
992- ```console
993- $ exec zsh
994- $
995- ```
996+```zsh
997+plugins=(... lol)
998+```
999
1000 ## Aliases
1001
1002-| Alias | Command |
1003-| ------------ | ---------------------------------------------------------------- |
1004-| `:3` | `echo` |
1005-| `alwayz` | `tail -f` |
1006-| `bringz` | `git pull` |
1007-| `btw` | `nice` |
1008-| `byes` | `exit` |
1009-| `chicken` | `git add` |
1010-| `cya` | `reboot` |
1011-| `donotwant` | `rm` |
1012-| `dowant` | `cp` |
1013-| `gimmeh` | `touch` |
1014-| `gtfo` | `mv` |
1015-| `hackzor` | `git init` |
1016-| `hai` | `cd` |
1017-| `icanhas` | `mkdir` |
1018-| `ihasbucket` | `df -h` |
1019-| `iminurbase` | `finger` |
1020-| `inur` | `locate` |
1021-| `invisible` | `cat` |
1022-| `iz` | `ls` |
1023-| `kthxbai` | `halt` |
1024-| `letcat` | `git checkout` |
1025-| `moar` | `more` |
1026-| `nomnom` | `killall` |
1027-| `nomz` | `ps aux` |
1028-| `nowai` | `chmod` |
1029-| `oanward` | `git commit -m` |
1030-| `obtw` | `nohup` |
1031-| `onoz` | `cat /var/log/errors.log` |
1032-| `ooanward` | `git commit -am` |
1033-| `plz` | `pwd` |
1034-| `pwned` | `ssh` |
1035-| `rtfm` | `man` |
1036-| `rulz` | `git push` |
1037-| `tldr` | `less` |
1038-| `violenz` | `git rebase` |
1039-| `visible` | `echo` |
1040-| `wtf` | `dmesg` |
1041-| `yolo` | `git commit -m "$(curl -s http://whatthecommit.com/index.txt)"` |
1042+| Alias | Command |
1043+| ------------ | --------------------------------------------------------------- |
1044+| `:3` | `echo` |
1045+| `alwayz` | `tail -f` |
1046+| `bringz` | `git pull` |
1047+| `btw` | `nice` |
1048+| `byes` | `exit` |
1049+| `chicken` | `git add` |
1050+| `cya` | `reboot` |
1051+| `donotwant` | `rm` |
1052+| `dowant` | `cp` |
1053+| `gimmeh` | `touch` |
1054+| `gtfo` | `mv` |
1055+| `hackzor` | `git init` |
1056+| `hai` | `cd` |
1057+| `icanhas` | `mkdir` |
1058+| `ihasbucket` | `df -h` |
1059+| `iminurbase` | `finger` |
1060+| `inur` | `locate` |
1061+| `invisible` | `cat` |
1062+| `iz` | `ls` |
1063+| `kthxbai` | `halt` |
1064+| `letcat` | `git checkout` |
1065+| `moar` | `more` |
1066+| `nomnom` | `killall` |
1067+| `nomz` | `ps aux` |
1068+| `nowai` | `chmod` |
1069+| `oanward` | `git commit -m` |
1070+| `obtw` | `nohup` |
1071+| `onoz` | `cat /var/log/errors.log` |
1072diff --git a/plugins/mercurial/README.md b/plugins/mercurial/README.md
1073index 68c7d0f43d22b6c17b11f2951f4f907789e50e14..80ea2de31e08f4ce01cd74b0a7b899dfe81a5ce4 100644
1074--- a/plugins/mercurial/README.md
1075+++ b/plugins/mercurial/README.md
1076@@ -1,61 +1,66 @@
1077 # Mercurial plugin
1078-### Usage
1079-Update .zshrc:
1080-
1081-1. Add name to the list of plugins, e.g. `plugins=(... mercurial ...)`
1082- (that is pretty obvious).
1083-2. Switch to a theme which uses `hg_prompt_info`.
1084-
1085- Or, customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info. This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in `.zshrc` after loading the theme.
1086-
1087- The `robbyrussell` theme is used by default, so you need to modify `$PROMPT` var by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so it looks like this:
1088-
1089- ```zsh
1090- PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
1091- ```
1092-
1093-3. Initialize additional vars used in plugin. So in short put next in **.zshrc**:
1094-
1095- ```
1096- ZSH_THEME_HG_PROMPT_PREFIX="%{$fg_bold[magenta]%}hg:(%{$fg[red]%}"
1097- ZSH_THEME_HG_PROMPT_SUFFIX="%{$reset_color%}"
1098- ZSH_THEME_HG_PROMPT_DIRTY="%{$fg[magenta]%}) %{$fg[yellow]%}✗%{$reset_color%}"
1099- ZSH_THEME_HG_PROMPT_CLEAN="%{$fg[magenta]%})"
1100- ```
1101-
1102-### What's inside?
1103-#### Adds handy aliases:
1104-###### general
1105-* `hga` - 'hg add`
1106-* `hgc` - `hg commit`
1107-* `hgb` - `hg branch`
1108-* `hgba` - `hg branches`
1109-* `hgbk` - `hg bookmarks`
1110-* `hgco` - `hg checkout`
1111-* `hgd` - `hg diff`
1112-* `hged` - `hg diffmerge`
1113-
1114-###### pull and update
1115-* `hgi` - `hg incoming`
1116-* `hgl` - `hg pull -u`
1117-* `hglr` - `hg pull --rebase`
1118-* `hgo` - `hg outgoing`
1119-* `hgp` - `hg push`
1120-* `hgs` - `hg status`
1121-* `hgsl` - `hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"`
1122-
1123-###### this is the 'git commit --amend' equivalent
1124-* `hgca` - `hg qimport -r tip ; hg qrefresh -e ; hg qfinish tip`
1125-
1126-###### list unresolved files (since hg does not list unmerged files in the status command)
1127-* `hgun` - `hg resolve --list`
1128-
1129-#### Displays repo branch and directory status in prompt
1130-This is the same as git plugin does.
1131-
1132-**Note**: Additional changes to **.zshrc**, or using a theme designed to use `hg_prompt_info`, are required in order for this to work.
1133-
1134-### Mantainers
1135-[ptrv](https://github.com/ptrv) - original creator
1136-
1137-[oshybystyi](https://github.com/oshybystyi) - created this README and know how most of code works
1138+
1139+This plugin adds some handy aliases for using Mercurial as well as a few
1140+utility and prompt functions that can be used in a theme.
1141+
1142+To use it, add `mercurial` to the plugins array in your zshrc file:
1143+
1144+```zsh
1145+plugins=(... mercurial)
1146+```
1147+
1148+## Aliases
1149+
1150+| Alias | Command |
1151+|--------|-------------------------------------------------------------------------------------------------------------|
1152+| `hga` | `hg add` |
1153+| `hgc` | `hg commit` |
1154+| `hgca` | `hg commit --amend` |
1155+| `hgb` | `hg branch` |
1156+| `hgba` | `hg branches` |
1157+| `hgbk` | `hg bookmarks` |
1158+| `hgco` | `hg checkout` |
1159+| `hgd` | `hg diff` |
1160+| `hged` | `hg diffmerge` |
1161+| `hgp` | `hg push` |
1162+| `hgs` | `hg status` |
1163+| `hgsl` | `hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"` |
1164+| `hgun` | `hg resolve --list` |
1165+| `hgi` | `hg incoming` |
1166+| `hgl` | `hg pull -u` |
1167+| `hglr` | `hg pull --rebase` |
1168+| `hgo` | `hg outgoing` |
1169+
1170+## Prompt usage
1171+
1172+- Switch to a theme which uses `hg_prompt_info`
1173+
1174+- Or customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info.
1175+ This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in
1176diff --git a/plugins/mercurial/mercurial.plugin.zsh b/plugins/mercurial/mercurial.plugin.zsh
1177index 58bc571a005380642fe43842e4c742d18964fdf9..f13430476af55fd7cd8605e3e19c0c2a5b87d6af 100644
1178--- a/plugins/mercurial/mercurial.plugin.zsh
1179+++ b/plugins/mercurial/mercurial.plugin.zsh
1180@@ -1,23 +1,22 @@
1181-# Mercurial
1182+# aliases
1183 alias hga='hg add'
1184 alias hgc='hg commit'
1185+alias hgca='hg commit --amend'
1186 alias hgb='hg branch'
1187 alias hgba='hg branches'
1188 alias hgbk='hg bookmarks'
1189 alias hgco='hg checkout'
1190 alias hgd='hg diff'
1191 alias hged='hg diffmerge'
1192+alias hgp='hg push'
1193+alias hgs='hg status'
1194+alias hgsl='hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"'
1195+alias hgun='hg resolve --list'
1196 # pull and update
1197 alias hgi='hg incoming'
1198 alias hgl='hg pull -u'
1199 alias hglr='hg pull --rebase'
1200 alias hgo='hg outgoing'
1201-alias hgp='hg push'
1202-alias hgs='hg status'
1203-alias hgsl='hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n" '
1204-alias hgca='hg commit --amend'
1205-# list unresolved files (since hg does not list unmerged files in the status command)
1206-alias hgun='hg resolve --list'
1207
1208 function in_hg() {
1209 if [[ -d .hg ]] || $(hg summary > /dev/null 2>&1); then
1210diff --git a/plugins/meteor/README.md b/plugins/meteor/README.md
1211index 187a45a62e33531984dde922919f537311436bfc..f7c43b7bd2799ab611db69cbed223a09bc375b51 100644
1212--- a/plugins/meteor/README.md
1213+++ b/plugins/meteor/README.md
1214@@ -1,9 +1,10 @@
1215-## Introduction
1216+# meteor plugin
1217
1218 The [meteor plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/meteor) provides many
1219 [useful aliases](#aliases) as well as completion for the `meteor` command.
1220
1221 Enable it by adding `meteor` to the plugins array in your zshrc file:
1222+
1223 ```zsh
1224 plugins=(... meteor)
1225 ```
1226diff --git a/plugins/mvn/README.md b/plugins/mvn/README.md
1227index 3bbba5b4fb9764e2b1b5dc02e4403d1c4ab7530f..72cea9cb93d94cc33a546cdd1b7ceedf37d1772a 100644
1228--- a/plugins/mvn/README.md
1229+++ b/plugins/mvn/README.md
1230@@ -4,6 +4,7 @@ The mvn plugin provides many [useful aliases](#aliases) as well as completion fo
1231 the [Apache Maven](https://maven.apache.org/) command (`mvn`).
1232
1233 Enable it by adding `mvn` to the plugins array in your zshrc file:
1234+
1235 ```zsh
1236 plugins=(... mvn)
1237 ```
1238diff --git a/plugins/mysql-macports/README.md b/plugins/mysql-macports/README.md
1239index a4224d9c0f4fbb29c8079608eb6523c5d39dfb79..ff4fb3a3429f163371f9dc0c134a71748e23cb9f 100644
1240--- a/plugins/mysql-macports/README.md
1241+++ b/plugins/mysql-macports/README.md
1242@@ -12,9 +12,9 @@ For instructions on how to install MySQL using MacPorts, read the [MacPorts wiki
1243
1244 ## Aliases
1245
1246-| Alias | Command | Description |
1247-| ------------ | --------------------------------------------------------- | ------------------------------------------ |
1248-| mysqlstart | `sudo /opt/local/share/mysql5/mysql/mysql.server start` | Start the MySQL server. |
1249-| mysqlstop | `sudo /opt/local/share/mysql5/mysql/mysql.server stop` | Stop the MySQL server. |
1250-| mysqlrestart | `sudo /opt/local/share/mysql5/mysql/mysql.server restart` | Restart the MySQL server. |
1251-| mysqlstatus | `mysqladmin5 -u root -p ping` | Check whether the MySQL server is running. |
1252+| Alias | Command | Description |
1253+| ------------ | ------------------------------------ | ------------------------------------------ |
1254+| mysqlstart | `sudo /path/to/mysql.server start` | Start the MySQL server. |
1255+| mysqlstop | `sudo /path/to/mysql.server stop` | Stop the MySQL server. |
1256+| mysqlrestart | `sudo /path/to/mysql.server restart` | Restart the MySQL server. |
1257+| mysqlstatus | `mysqladmin5 -u root -p ping` | Check whether the MySQL server is running. |
1258diff --git a/plugins/node/README.md b/plugins/node/README.md
1259index c392dc0bfb0361ea064cda4d77160bfc556a4ee4..911b6693ba70096240f4d58851c6b1b2eb079780 100644
1260--- a/plugins/node/README.md
1261+++ b/plugins/node/README.md
1262@@ -1,16 +1,19 @@
1263 # node plugin
1264
1265+This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
1266+documentation (depending on the installed version).
1267+
1268 To use it, add `node` to the plugins array of your zshrc file:
1269+
1270 ```zsh
1271 plugins=(... node)
1272 ```
1273
1274-This plugin adds `node-docs` function that open specific section in [Node.js](https://nodejs.org) documentation (depending on the installed version).
1275-For example:
1276+## Usage
1277
1278 ```zsh
1279 # Opens https://nodejs.org/docs/latest-v10.x/api/fs.html
1280 $ node-docs fs
1281 # Opens https://nodejs.org/docs/latest-v10.x/api/path.html
1282-$ node-docs path
1283+$ node-docs path
1284 ```
1285diff --git a/plugins/npm/README.md b/plugins/npm/README.md
1286index 202e2b0a47fe2931cfd6074851a6a0a4db0460f0..0b1a2280f27edc2931ba3b28bf575a8b1747434f 100644
1287--- a/plugins/npm/README.md
1288+++ b/plugins/npm/README.md
1289@@ -1,9 +1,10 @@
1290-## npm plugin
1291+# npm plugin
1292
1293 The npm plugin provides completion as well as adding many useful aliases.
1294
1295 To use it, add npm to the plugins array of your zshrc file:
1296-```
1297+
1298+```zsh
1299 plugins=(... npm)
1300 ```
1301
1302diff --git a/plugins/osx/README.md b/plugins/osx/README.md
1303index f3881ec6bef685dd0750d6ba4695dc6a3cf7eae0..50e9e7f21d17f9dcaa9a6d09b3011e7d82140bbc 100644
1304--- a/plugins/osx/README.md
1305+++ b/plugins/osx/README.md
1306@@ -1,8 +1,6 @@
1307 # OSX plugin
1308
1309-## Description
1310-
1311-This plugin provides a few utilities to make it more enjoyable on OSX.
1312+This plugin provides a few utilities to make it more enjoyable on macOS (previously named OSX).
1313
1314 To start using it, add the `osx` plugin to your plugins array in `~/.zshrc`:
1315
1316@@ -12,6 +10,27 @@ plugins=(... osx)
1317
1318 Original author: [Sorin Ionescu](https://github.com/sorin-ionescu)
1319
1320+## Commands
1321+
1322+| Command | Description |
1323+| :-------------- | :---------------------------------------------------- |
1324+| `tab` | Open the current directory in a new tab |
1325+| `split_tab` | Split the current terminal tab horizontally |
1326+| `vsplit_tab` | Split the current terminal tab vertically |
1327+| `ofd` | Open the current directory in a Finder window |
1328+| `pfd` | Return the path of the frontmost Finder window |
1329+| `pfs` | Return the current Finder selection |
1330+| `cdf` | `cd` to the current Finder directory |
1331+| `pushdf` | `pushd` to the current Finder directory |
1332+| `quick-look` | Quick-Look a specified file |
1333+| `man-preview` | Open a specified man page in Preview app |
1334+| `showfiles` | Show hidden files |
1335+| `hidefiles` | Hide the hidden files |
1336+| `itunes` | DEPRECATED. Use `music` from macOS Catalina on |
1337+| `music` | Control Apple Music. Use `music -h` for usage details |
1338+| `spotify` | Control Spotify and search by artist, album, track… |
1339+| `rmdsstore` | Remove .DS\_Store files recursively in a directory |
1340+
1341 ## Acknowledgements
1342
1343 This application makes use of the following third party scripts:
1344@@ -38,25 +57,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
1345 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
1346 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
1347 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1348-
1349-
1350-## Commands
1351-
1352-| Command | Description |
1353-| :-------------- | :---------------------------------------------------- |
1354-| `tab` | Open the current directory in a new tab |
1355-| `split_tab` | Split the current terminal tab horizontally |
1356-| `vsplit_tab` | Split the current terminal tab vertically |
1357-| `ofd` | Open the current directory in a Finder window |
1358-| `pfd` | Return the path of the frontmost Finder window |
1359-| `pfs` | Return the current Finder selection |
1360-| `cdf` | `cd` to the current Finder directory |
1361-| `pushdf` | `pushd` to the current Finder directory |
1362-| `quick-look` | Quick-Look a specified file |
1363-| `man-preview` | Open a specified man page in Preview app |
1364-| `showfiles` | Show hidden files |
1365-| `hidefiles` | Hide the hidden files |
1366-| `itunes` | DEPRECATED. Use `music` from macOS Catalina on |
1367-| `music` | Control Apple Music. Use `music -h` for usage details |
1368-| `spotify` | Control Spotify and search by artist, album, track… |
1369-| `rmdsstore` | Remove .DS\_Store files recursively in a directory |